Skip to content

JavaScript documentation notation #1

Open
@dtracers

Description

@dtracers

Inside a javadoc comment add these options to notate certain items.
@Class - tells the parser that the function is a class
@method - tells the parser it is a function
@field - tells the parser the next item is a field
@StartFields
@EndFields - these tell the parser where the fields are.
@SeeClass:ClassName - tells the parser to try and link a certain class to another class
@SeeClass:ClassName#MethodName - tells the parser to try and link a certain method to another method.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions