MethodCommentSignature

class MethodCommentSignature( val name: String, val module: String, orderedInputTypes: MutableList<String>, returnType: String) : CommentSignature

The defining characteristic of a method comment as it pertains to the implementation it describes.

Richard Arriaga

Parameters

name

The name of the class/method the comment describes.

module

The module this implementation appears in.

orderedInputTypes

The method parameter input types in order of input

returnType

The return type, if none,⊤.

fun MethodCommentSignature( name: String, module: String, orderedInputTypes: MutableList<String>, returnType: String)

open fun toJSON( nameOfGroup: String, sticky: Boolean, jsonWriter: JSONWriter)

Create the JSON representation of the signature.

open override fun toString(): String

The module this implementation appears in.

The name of the class/method the comment describes.