Function generatePluginAndMacroDocumentation

generatePluginAndMacroDocumentation(strings: StringMap, plugins: DeepReadonlyArray<MessageParserPlugin>, macros: DeepReadonlyArray<MessageParserMacro<string>>, optionalPlugins: OrUndef<DeepReadonlyArray<MessageParserPluginInfo>>, optionalMacros: OrUndef<DeepReadonlyArray<MessageParserMacroDocumentation<string>>>, logger: Readonly<Logger>): Promise<FileDocumentationParts[]>
Parameters
- strings: StringMap
- plugins: DeepReadonlyArray<MessageParserPlugin>
- macros: DeepReadonlyArray<MessageParserMacro<string>>
- optionalPlugins: OrUndef<DeepReadonlyArray<MessageParserPluginInfo>>
- optionalMacros: OrUndef<DeepReadonlyArray<MessageParserMacroDocumentation<string>>>
- logger: Readonly<Logger>
Returns Promise<FileDocumentationParts[]>
- Defined in src/documentation/messageParser.ts:200

Generated using TypeDoc