avail/avail.stacks.comment/ModuleComment/ModuleComment

ModuleComment

fun ModuleComment(    signature: CommentSignature,     commentStartLine: Int,     author: MutableList<StacksAuthorTag>,     sees: MutableList<StacksSeeTag>,     description: StacksDescription,     sticky: Boolean)
Content copied to clipboard

Construct a new ModuleComment.

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

sticky

or not the method should be documented regardless of visibility