avail/avail.stacks.module/CommentsModule

CommentsModule

class CommentsModule( header: ModuleHeader, commentTokens: A_Tuple, errorLog: StacksErrorLog, resolver: ModuleNameResolver, moduleToComments: MutableMap<String, CommentsModule>, linkingFileMap: LinkingFileMap, linkPrefix: String)

A representation of all the fully parsed comments in a given module

Author

Richard Arriaga

Parameters

header

The ModuleHeader of the current file

commentTokens

A A_Tuple of all the comment tokens.

errorLog

The file for outputting all errors.

resolver

The ModuleNameResolver for resolving module paths.

moduleToComments

A map of module names to a list of all the method names exported from said module

linkingFileMap

A map for all output files in Stacks

linkPrefix

An optional prefix to all files' link web links

Constructors

CommentsModule

fun CommentsModule( header: ModuleHeader, commentTokens: A_Tuple, errorLog: StacksErrorLog, resolver: ModuleNameResolver, moduleToComments: MutableMap<String, CommentsModule>, linkingFileMap: LinkingFileMap, linkPrefix: String)

Construct a new CommentsModule.

Functions

calculateFinalImplementationGroupsMap

fun calculateFinalImplementationGroupsMap( linkingFileMap: LinkingFileMap, outputPath: Path, runtime: AvailRuntime, topLevelLinkFolderPath: String): Int

Acquire all distinct implementations being directly exported or extended by this module and populate finalImplementationsGroupMap.

writeMethodsToJSONFiles

fun writeMethodsToJSONFiles( outputPath: Path, synchronizer: StacksSynchronizer, runtime: AvailRuntime, linkingFileMap: LinkingFileMap, errorLog: StacksErrorLog)

Write all the methods and extends methods to file.

Properties

extendedNamesImplementations

val extendedNamesImplementations: MutableMap<String, StacksExtendsModule>

A map of the modules extended by this module to the StacksExtendsModule content.

extendsMethodLeafNameToModuleName

val extendsMethodLeafNameToModuleName: MutableMap<A_String, MutableMap<String, CommentGroup>>

A map keyed by a method name with no path to a map keyed by the qualified module path it is originally named from to the CommentGroup. These are all the methods exported from this module

moduleName

val moduleName: String

The name of the module that contains these Stacks Comments.

namedPublicCommentImplementations

val namedPublicCommentImplementations: MutableMap<A_String, CommentGroup>

All public methods/classes from this module.

usesMethodLeafNameToModuleName

val usesMethodLeafNameToModuleName: MutableMap<A_String, MutableMap<String, CommentGroup>>

A map keyed by a method name with no path to a map keyed by the qualified module path it is originally named from to the CommentGroup. These are all the methods defined in this module and are "public" because it uses a module where the name is exported from.

usesNamesImplementations

var usesNamesImplementations: MutableMap<String, StacksUsesModule>

A map of the modules used by this module to the StacksUsesModule content.