Method
fun MethodComment( signature: MethodCommentSignature, commentStartLine: Int, author: MutableList<StacksAuthorTag>, sees: MutableList<StacksSeeTag>, description: StacksDescription, categories: MutableList<StacksCategoryTag>, aliases: MutableList<StacksAliasTag>, parameters: MutableList<StacksParameterTag>, returnsContent: StacksReturnTag, exceptions: MutableList<StacksRaisesTag>, sticky: Boolean)
Content copied to clipboard
Construct a new MethodComment.
Parameters
signature
The signature of the class/method the comment describes.
comment
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.
returns
The "@returns" content
exceptions
A MutableList of any exceptions the method throws.
sticky
Whether or not the method should be documented regardless of visibility