conscience_core::bridging::commands::doc Namespace Reference

Classes
struct	CscCommandDocGenerationContext
class	CscCommandsDocGenerator
struct	ExampleGenerationOptions

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

Variables
static auto	logger = CscLogger::getForCategory("CscCommandsDocGenerator")

Function Documentation

appendCommandDocumentation() [1/2]

CSC_DLL_IMPORTEXPORT void conscience_core::bridging::commands::doc::appendCommandDocumentation	(	const CscCommandDataTypeMetadata *	commandSpec,
		string &	targetString,
		const CscCommandDocGenerationContext &	context
	)

appendCommandDocumentation() [2/2]

void conscience_core::bridging::commands::doc::appendCommandDocumentation	(	const CscCommandDataTypeMetadata *	commandSpec,
		string &	targetString,
		map< string, const CscCommandResultMetadata * >	resultsMetadata,
		const CscCommandDocGenerationContext &	context
	)

bold()

string conscience_core::bridging::commands::doc::bold ( const string &  text, const CscCommandDocGenerationContext &  context  )

inline

codeBlockEnd()

string conscience_core::bridging::commands::doc::codeBlockEnd ( const CscCommandDocGenerationContext &  context )

inline

codeBlockStart()

string conscience_core::bridging::commands::doc::codeBlockStart ( const CscCommandDocGenerationContext &  context )

inline

commandParamTypeToStringForAPIDoc() [1/2]

string conscience_core::bridging::commands::doc::commandParamTypeToStringForAPIDoc

(

const CscCommandDataTypeNodeMetadata *

paramMetadata

)

commandParamTypeToStringForAPIDoc() [2/2]

string conscience_core::bridging::commands::doc::commandParamTypeToStringForAPIDoc	(	const CscCommandDataTypeNodeMetadata *	paramMetadata,
		const CscCommandDocGenerationContext &	context
	)

dataTypeDoc()

string conscience_core::bridging::commands::doc::dataTypeDoc	(	const CscCommandDataTypeMetadata *	type,
		const CscCommandDocGenerationContext &	context
	)

dataTypesDoc()

string conscience_core::bridging::commands::doc::dataTypesDoc	(	const vector< const CscCommandDataTypeMetadata * > &	types,
		const CscCommandDocGenerationContext &	context,
		const vector< const CscCommandDataTypeMetadata * > &	excludedTypes = {}
	)

docTitle()

string conscience_core::bridging::commands::doc::docTitle ( const string &  text, const CscCommandDocGenerationContext &  context, int  level = 1  )

inline

endLine()

string conscience_core::bridging::commands::doc::endLine ( const CscCommandDocGenerationContext &  context )

inline

enumsDoc()

string conscience_core::bridging::commands::doc::enumsDoc	(	const vector< const CscEnumInfos * > &	enums,
		const CscCommandDocGenerationContext &	context
	)

exampleEntitySerialNumberString()

string conscience_core::bridging::commands::doc::exampleEntitySerialNumberString

(

)

exampleValueForAPIDoc()

string conscience_core::bridging::commands::doc::exampleValueForAPIDoc	(	const CscCommandResultMetadata *	resultMetadata,
		const ExampleGenerationOptions &	options
	)

generateCommandExampleListValue()

string conscience_core::bridging::commands::doc::generateCommandExampleListValue	(	const CscCommandDataTypeNodeMetadata *	elementType,
		const string &	parentPath,
		const map< string, string > &	specifiedValues,
		bool	hasAnyOptionalParent,
		const ExampleGenerationOptions &	options
	)

Parameters

elementType	param type metadata
parentPath	path in params to reach this param, e.g. filters.position.x
specifiedValues	indicates if some params are filled by user
hasAnyOptionalParent	indicate if one of current param ancestors is optional

generateCommandExampleObjectValue()

string conscience_core::bridging::commands::doc::generateCommandExampleObjectValue	(	const CscCommandDataTypeMetadata *	objectMetadata,
		const string &	parentPath,
		const map< string, string > &	specifiedValues,
		bool	hasAnyOptionalParent,
		const ExampleGenerationOptions &	options
	)

Parameters

objectMetadata	object metadata
parentPath	path in params to reach this param, e.g. filters.position.x
specifiedValues	indicates if some params are filled by user
hasAnyOptionalParent	indicate if one of current param ancestors is optional

generateCommandExampleValue()

string conscience_core::bridging::commands::doc::generateCommandExampleValue	(	const CscCommandDataTypeNodeMetadata *	paramMetadata,
		const string &	parentPath,
		const map< string, string > &	specifiedValues,
		bool	hasAnyOptionalParent,
		const ExampleGenerationOptions &	options
	)

Parameters

paramMetadata	param type metadata
parentPath	path in params to reach this param, e.g. filters.position.x
specifiedValues	indicates if some params are filled by user
hasAnyOptionalParent	indicate if one of current param ancestors is optional

generateCommandFormatDoc()

CSC_DLL_IMPORTEXPORT string conscience_core::bridging::commands::doc::generateCommandFormatDoc	(	const CscCommandDataTypeMetadata *	commandSpec,
		const CscCommandDocGenerationContext &	context
	)

generateCommandResultDoc()

CSC_DLL_IMPORTEXPORT string conscience_core::bridging::commands::doc::generateCommandResultDoc	(	const CscCommandDataTypeMetadata *	commandSpec,
		const CscCommandResultMetadata *	resultMetadata,
		const CscCommandDocGenerationContext &	context
	)

generateCommandStringPaddedWithExampleValues()

CSC_DLL_IMPORTEXPORT string conscience_core::bridging::commands::doc::generateCommandStringPaddedWithExampleValues	(	const CscCommandDataTypeMetadata *	commandSpec,
		const map< string, string > &	specifiedValues,
		bool	fillOptionalValues
	)

logCommandDocumentation()

CSC_DLL_IMPORTEXPORT void conscience_core::bridging::commands::doc::logCommandDocumentation	(	const string &	commandId,
		const CscCommandDocGenerationContext &	context
	)

paramTypeToStringForAPIDoc()

string conscience_core::bridging::commands::doc::paramTypeToStringForAPIDoc	(	const CscCommandDataTypeMetadata *	objectTypeMetadata,
		const CscCommandDocGenerationContext &	context
	)

prepareStringForMarkdownTagWrap()

string conscience_core::bridging::commands::doc::prepareStringForMarkdownTagWrap

(

const string &

text

)

randomExampleString()

string conscience_core::bridging::commands::doc::randomExampleString

(

const string &

prefix = "example"

)

Variable Documentation

logger

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

static