conscience_core::bridging::commands::doc::CscCommandsDocGenerator Class Reference

#include <CscCommandsDocGenerator.h>

Public Member Functions
	CscCommandsDocGenerator ()
vector< fs::path >	generateCommandsAPIDoc (const fs::path &targetDirPath, function< bool(const CscCommandDataTypeMetadata *commandSpec)> filter=[](auto commandSpec) { return true;}) const

Constructor & Destructor Documentation

CscCommandsDocGenerator()

conscience_core::bridging::commands::doc::CscCommandsDocGenerator::CscCommandsDocGenerator

(

)

Member Function Documentation

generateCommandsAPIDoc()

vector< fs::path > conscience_core::bridging::commands::doc::CscCommandsDocGenerator::generateCommandsAPIDoc	(	const fs::path &	targetDirPath,
		function< bool(const CscCommandDataTypeMetadata *commandSpec)>	filter = [](auto commandSpec) { return true; }
	)		const

Generate commands API documentation with markdown format to given target directory path.

Note

This will generate documentation for command based on their metadata

Parameters

filter

it is possible to pass a filter to generate documentation only for a subset of commandes

Returns

a list of generated files

---

The documentation for this class was generated from the following files:

• Bridging/EnvironmentInteractionCommands/Doc/CscCommandsDocGenerator.h
• Bridging/EnvironmentInteractionCommands/Doc/CscCommandsDocGenerator.cpp