GlobalComment

constructor(signature: CommentSignature, commentStartLine: Int, author: List<StacksAuthorTag>, sees: List<StacksSeeTag>, description: StacksDescription, categories: List<StacksCategoryTag>, aliases: List<StacksAliasTag>, globalTag: StacksGlobalTag)

Construct a new GlobalComment.

Parameters

signature

The signature of the class/method 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.

globalTag

A global module variable comment tag.