MacroComment

constructor(signature: MethodCommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, parameters: List<StacksParameterTag>, returnsContent: StacksReturnTag, exceptions: List<StacksRaisesTag>, sticky: Boolean)

Construct a new MacroComment.

Parameters

signature

The signature of the macro the comment describes.

commentStartLine

The start line in the module the comment being parsed appears.

author

The author of the implementation.

sees

A List of any "@sees" references.

description

The overall description of the implementation

categories

The categories the implementation appears in

aliases

The aliases the implementation is known by

parameters

The list of parameters of the method implementation.

returnsContent

The "@returns" content

exceptions

A list of any exceptions the method throws.

sticky

Whether or not the method should be documented regardless of visibility