Tags

Tags give the ability to mark specific points in history as being important

  • 0.2.1

    17939e77 · chore: Bump version to 0.2.1 · 
    Fixed
------------------

- Invalid imbricated types are now matched against YARD types (no more issues with types like `[String, Array[String]]`)
- `Yardoc/MethodDescription` is now triggered when method docblock contains only tags
    Verified

  • 0.2.0

    5ea9b9f3 · chore: Bump version to 0.2.0 · 
    Added
---------------

- cop: `Yardoc/TypesFormat` - Ensure types are separated with a comma and a space
- cop: `Yardoc/ValidTypes` - Ensure the types are parseable by YARD

Changed
---------------

Reworked parts of the code
    Verified

  • 0.1.0

    2fc01475 · chore: Bump version to 0.1.0 · 
    Initial release with following cops:
  - `Yardoc/ClassDescription`:  Ensure that classes are documented, with an ignore list of names
  - `Yardoc/ColumnParams`: Ensure that parameters elements are aligned
  - `Yardoc/ConstantDescription`:  Ensure that constants are documented, with an ignore list of names
  - `Yardoc/MethodDescription`:  Ensure that methods have a description, with an ignore list of names
  - `Yardoc/ModuleDescription`: Ensure that modules are documented, with an ignore list of names
  - `Yardoc/ParamDescriptionCasing`: Ensure that the first letter of a parameter is an uppercase letter
  - `Yardoc/ParamDocumentation`: Ensure that parameters are fully documented (type and description), with an option to
     ignore description
  - `Yardoc/SeparateTagsBlocks`: Ensure consecutive blocks of the same tag are separated with empty spaces from other
    tags
  - `Yardoc/SupportedTags`: Ensure that tags used in documentation are supported by Yardoc (base + custom registered ones),
     with an ignore list
  - `Yardoc/TagOrder`: Ensure that tags follows a defined order in the documentation block, with option to re-define the
     list
  - `Yardoc/YieldDocumentation`: Ensure that blocks and block arguments are documented, with an option to disable
     arguments check.
    Verified