Skip to content

Make @example a known doc tag #1453

@timotheeguerin

Description

@timotheeguerin

Proposal

Add @example as a known tag with the following format

First line is the title (optional - if line is empty then there is no title)
Rest is the tag content

/**
 *  @example First line is example title
 * rest is 
 * example
 * content
 *
 */

woudl result in the following

{
  title: "First line is example title",
  content: "rest is\nexample\ncontent",
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions