CscCommandsDocGenerator.cpp File Reference

#include "CscCommandsDocGenerator.h"
#include "Util/fs.h"

Classes
struct	conscience_core::bridging::commands::doc::ExampleGenerationOptions

Namespaces
	conscience_core
	conscience_core::bridging
	conscience_core::bridging::commands
	conscience_core::bridging::commands::doc

Functions
string	conscience_core::bridging::commands::doc::generateCommandExampleValue (const CscCommandDataTypeNodeMetadata *paramMetadata, const string &parentPath, const map< string, string > &specifiedValues, bool hasAnyOptionalParent, const ExampleGenerationOptions &options)
string	conscience_core::bridging::commands::doc::generateCommandExampleObjectValue (const CscCommandDataTypeMetadata *objectMetadata, const string &parentPath, const map< string, string > &specifiedValues, bool hasAnyOptionalParent, const ExampleGenerationOptions &options)
string	conscience_core::bridging::commands::doc::generateCommandExampleListValue (const CscCommandDataTypeNodeMetadata *elementType, const string &parentPath, const map< string, string > &specifiedValues, bool hasAnyOptionalParent, const ExampleGenerationOptions &options)
string	conscience_core::bridging::commands::doc::commandParamTypeToStringForAPIDoc (const CscCommandDataTypeNodeMetadata *paramMetadata)
string	conscience_core::bridging::commands::doc::paramTypeToStringForAPIDoc (const CscCommandDataTypeMetadata *objectTypeMetadata, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::exampleValueForAPIDoc (const CscCommandResultMetadata *resultMetadata, const ExampleGenerationOptions &options)
string	conscience_core::bridging::commands::doc::dataTypeDoc (const CscCommandDataTypeMetadata *type, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::dataTypesDoc (const vector< const CscCommandDataTypeMetadata * > &types, const CscCommandDocGenerationContext &context, const vector< const CscCommandDataTypeMetadata * > &excludedTypes={})
string	conscience_core::bridging::commands::doc::docTitle (const string &text, const CscCommandDocGenerationContext &context, int level=1)
string	conscience_core::bridging::commands::doc::bold (const string &text, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::endLine (const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::codeBlockStart (const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::codeBlockEnd (const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::randomExampleString (const string &prefix="example")
string	conscience_core::bridging::commands::doc::commandParamTypeToStringForAPIDoc (const CscCommandDataTypeNodeMetadata *paramMetadata, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::prepareStringForMarkdownTagWrap (const string &text)
string	conscience_core::bridging::commands::doc::enumsDoc (const vector< const CscEnumInfos * > &enums, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::generateCommandResultDoc (const CscCommandDataTypeMetadata *commandSpec, const CscCommandResultMetadata *resultMetadata, const CscCommandDocGenerationContext &context)
void	conscience_core::bridging::commands::doc::logCommandDocumentation (const string &commandId, const CscCommandDocGenerationContext &context)
void	conscience_core::bridging::commands::doc::appendCommandDocumentation (const CscCommandDataTypeMetadata *commandSpec, string &targetString, map< string, const CscCommandResultMetadata * > resultsMetadata, const CscCommandDocGenerationContext &context)
void	conscience_core::bridging::commands::doc::appendCommandDocumentation (const CscCommandDataTypeMetadata *commandSpec, string &targetString, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::generateCommandStringPaddedWithExampleValues (const CscCommandDataTypeMetadata *commandSpec, const map< string, string > &specifiedValues, bool fillOptionalValues)
string	conscience_core::bridging::commands::doc::generateCommandFormatDoc (const CscCommandDataTypeMetadata *commandSpec, const CscCommandDocGenerationContext &context)
string	conscience_core::bridging::commands::doc::exampleEntitySerialNumberString ()

Variables
static auto	conscience_core::bridging::commands::doc::logger = CscLogger::getForCategory("CscCommandsDocGenerator")