Apply suggestions from code review

cebe · web-flow · commit 333aa5f44b0b · 2020-12-14T23:41:36.000+01:00
diff --git a/src/Reader.php b/src/Reader.php
@@ -62,7 +62,8 @@ public static function readFromYaml(string $yaml, string $baseType = OpenApi::cl
      * If `true`, all [[Reference]] objects will be replaced with their referenced spec objects by calling
      * [[SpecObjectInterface::resolveReferences()]].
      * Since version 1.5.0 this can be a string indicating the reference resolving mode:
-     * - TODO inline vs all
+     * - `inline` only resolve references to external files.
+     * - `all` resolve all references exceot recursive references.
      * @return SpecObjectInterface|OpenApi the OpenApi object instance.
      * The type of the returned object depends on the `$baseType` argument.
      * @throws TypeErrorException in case invalid spec data is supplied.
@@ -102,7 +103,8 @@ public static function readFromJsonFile(string $fileName, string $baseType = Ope
      * If `true`, all [[Reference]] objects will be replaced with their referenced spec objects by calling
      * [[SpecObjectInterface::resolveReferences()]].
      * Since version 1.5.0 this can be a string indicating the reference resolving mode:
-     * - TODO inline vs all
+     * - `inline` only resolve references to external files.
+     * - `all` resolve all references exceot recursive references.
      * @return SpecObjectInterface|OpenApi the OpenApi object instance.
      * The type of the returned object depends on the `$baseType` argument.
      * @throws TypeErrorException in case invalid spec data is supplied.
