Skip to content

Should document doc comment directives #2338

Open
@srawlins

Description

@srawlins

Right now, it looks like the only documentation for {@animation}, {@template}, {@youtube}, etc exists as doc comments on private methods in comment_processable.dart. We should document, perhaps in a top-level markdown file, or the wiki:

  • the syntax for each directive
  • any interoperability between them (can you write a {@template} with a {@youtube} inside?)
  • what directives are accepted in Flutter's docs, pub.dev's docs, and Dart API docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2A bug or feature request we're likely to work ontype-code-healthInternal changes to our tools and workflows to make them cleaner, simpler, or more maintainabletype-documentationA request to add or improve documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions