Update documentation

Author: nyamsprod

CHANGELOG.md

@@ -6,17 +6,26 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 
 ### Added
 
-- Public API around accessing parameters using their index instead of their key.
+- `OrederedMap::push`
+- `OrederedMap::unshift`
+- `OrederedMap::insert`
+- `OrederedMap::replace`
+- `ParameterAccess::pushParanmeters`
+- `ParameterAccess::unshiftParamaters`
+- `ParameterAccess::insertParamaters`
+- `ParameterAccess::replaceParamater`
+- `ParameterAccess::withoutParametersByKeys`
+- `ParameterAccess::withoutParametersByIndices`
 
 ### Fixed
 
-- `Parameters::remove` also removes parameters per indexes
+- `Parameters::remove` also removes parameters per indices
 - `Type::fromValue` throws an `InvalidArgument` exception.
 - `Type::fromValue` and `Type::tryFromValue` should only check the PHP variable type and not take into account the variable value.
 
 ### Deprecated
 
-- None
+- `ParameterAccess::withoutParameters` replaced by `ParameterAccess::withoutParametersBykeys`
 
 ### Removed
 

README.md

@@ -560,7 +560,7 @@ You can attach and update the associated `Parameters` instance using the followi
 $field->addParameter(string $key, mixed $value): static;
 $field->appendParameter(string $key, mixed $value): static;
 $field->prependParameter(string $key, mixed $value): static;
-$field->withoutParameters(string ...$keys): static;
+$field->withoutParameters(string ...$keys): static; // this method is deprecated as of version 1.1 use withoutParametersByKeys instead
 $field->withoutAnyParameter(): static;
 $field->withParameters(Parameters $parameters): static;
 ```
@@ -572,6 +572,8 @@ $field->pushParameters(array ...$pairs): static
 $field->unshiftParameters(array ...$pairs): static
 $field->insertParameters(int $index, array ...$pairs): static
 $field->replaceParameter(int $index, array $pair): static
+$field->withoutParametersByKeys(string ...$keys): static
+$field->withoutParametersByIndices(int ...$indices): static
 ```
 
 The `$pair` parameter is a tuple (ie: an array as list with exactly two members) where:

composer.json

@@ -30,13 +30,13 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^v3.15.1",
         "httpwg/structured-field-tests": "*@dev",
-        "phpstan/phpstan": "^1.10.13",
+        "phpstan/phpstan": "^1.10.14",
         "phpstan/phpstan-strict-rules": "^1.5.1",
         "phpstan/phpstan-phpunit": "^1.3.11",
         "phpstan/phpstan-deprecation-rules": "^1.1.3",
-        "phpunit/phpunit": "^10.1.0",
+        "phpunit/phpunit": "^10.1.2",
         "phpbench/phpbench": "^1.2.10",
-        "symfony/var-dumper": "^6.2.8"
+        "symfony/var-dumper": "^6.2.10"
     },
     "autoload": {
         "psr-4": {

src/Parser.php

@@ -22,11 +22,11 @@
  *
  * @see https://www.rfc-editor.org/rfc/rfc8941.html#section-4.2
  *
- * @see Dictionary::fromHttpValue(),
- * @see Parameters::fromHttpValue(),
- * @see OuterList::fromHttpValue(),
- * @see InnerList::fromHttpValue()
- * @see Item::fromHttpValue() instead
+ * @internal Use Dictionary::fromHttpValue(),
+ *               Parameters::fromHttpValue(),
+ *               OuterList::fromHttpValue(),
+ *               InnerList::fromHttpValue()
+ *            or Item::fromHttpValue() instead
  *
  * @phpstan-import-type SfType from StructuredField
  */