From bd96a46620934d1ed0e6d593ceb52228f77a8a68 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Fri, 19 Jan 2018 14:04:54 -0800 Subject: [PATCH 1/2] (PDOC-196) Correcting misinformation about supported YARD tags --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 94e8bcb..b448f30 100644 --- a/README.md +++ b/README.md @@ -403,15 +403,14 @@ function example(string $name) { The most commonly used tags for Strings are: -* `@param`: Documents a parameter with a given name, type and optional description. -* `@return`: Describes the return value (and type or types) of a method. You can list multiple return tags for a method if the method has distinct return cases. In this case, begin each case with "if". * `@example`: Shows an example snippet of code for an object. The first line is an optional title. See above for more about how to [include examples in documentation](#including-examples-in-documentation). +* `@param`: Documents a parameter with a given name, type and optional description. * `@!puppet.type.param`: Documents dynamic type parameters. See [Documenting resource types and providers](#documenting-resource-types-and-providers) above. * `@!puppet.type.property`: Documents dynamic type properties. See [Documenting resource types and providers](#documenting-resource-types-and-providers) above. -* `@since`: Lists the version in which the object was first added. +* `@return`: Describes the return value (and type or types) of a method. You can list multiple return tags for a method if the method has distinct return cases. In this case, begin each case with "if". * `@see`: Adds "see also" references. Accepts URLs or other code objects with an optional description at the end. Note that the URL or object is automatically linked by YARD and does not need markup formatting. - -For a complete list of tags, see the [YARD Tags Overview](http://www.rubydoc.info/gems/yard/file/docs/Tags.md). +* `@since`: Lists the version in which the object was first added. +* `@summary`: A short description of the documented item. ### Rake tasks From a5d39e752c5564edea0fc8cf13c31c5153c368a8 Mon Sep 17 00:00:00 2001 From: jbondpdx Date: Fri, 19 Jan 2018 14:20:09 -0800 Subject: [PATCH 2/2] (PDOC-196) further disambiguaion --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index b448f30..1d5a294 100644 --- a/README.md +++ b/README.md @@ -401,8 +401,6 @@ function example(string $name) { ### Available Strings tags -The most commonly used tags for Strings are: - * `@example`: Shows an example snippet of code for an object. The first line is an optional title. See above for more about how to [include examples in documentation](#including-examples-in-documentation). * `@param`: Documents a parameter with a given name, type and optional description. * `@!puppet.type.param`: Documents dynamic type parameters. See [Documenting resource types and providers](#documenting-resource-types-and-providers) above.