Skip to content

Mistake in Tags.md #223

@dominikh

Description

@dominikh

From http://rubydoc.info/docs/yard/file/docs/Tags.md:

@api: Declares the API that the object belongs to. Does not display in output, but useful for performing queries (yardoc --query). Any text is allowable in this tag, and there are no predefined values

That's not exactly true, however, since @api private will in fact cause a special note in the produced documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions