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

Link copied to clipboard
constructor(header: ModuleHeader, commentTokens: A_Tuple, errorLog: StacksErrorLog, resolver: ModuleNameResolver, moduleToComments: MutableMap<String, CommentsModule>, linkingFileMap: LinkingFileMap, linkPrefix: String)

Construct a new CommentsModule.

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The name of the module that contains these Stacks Comments.

Link copied to clipboard

All public methods/classes from this module.

Link copied to clipboard

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.

Link copied to clipboard

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

Functions

Link copied to clipboard
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.

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

Write all the methods and extends methods to file.