CscCommandsDocGenerator.h

Go to the documentation of this file.

#ifndef CommandsDocGenerator_h
#define CommandsDocGenerator_h
 
#include "../CommandParamsSpec.h"
#include "../Result/CommandResultSpec.h"
#include "CscCommon.h"
#include <functional>
 
using namespace conscience_core::bridging::commands::result;
 
using std::function;
 
namespace conscience_core::bridging::commands::doc {
 
ENUM(CscCommandDocGenerationFormat, CommandDocGenerationFormat_MARKDOWN, CommandDocGenerationFormat_HTML)
 
struct CSC_DLL_IMPORTEXPORT CscCommandDocGenerationContext {
    CscCommandDocGenerationFormat format = CommandDocGenerationFormat_MARKDOWN;
};
 
CSC_DLL_IMPORTEXPORT string generateCommandStringPaddedWithExampleValues(const CscCommandDataTypeMetadata *commandSpec, const map<string, string> &specifiedValues = {}, bool fillOptionalValues = false);
CSC_DLL_IMPORTEXPORT string generateCommandFormatDoc(const CscCommandDataTypeMetadata *commandSpec, const CscCommandDocGenerationContext &context);
CSC_DLL_IMPORTEXPORT string generateCommandResultDoc(const CscCommandDataTypeMetadata *commandSpec, const CscCommandResultMetadata *resultMetadata, const CscCommandDocGenerationContext &context);
CSC_DLL_IMPORTEXPORT void logCommandDocumentation(const string &commandId, const CscCommandDocGenerationContext &context = {});
CSC_DLL_IMPORTEXPORT void appendCommandDocumentation(const CscCommandDataTypeMetadata *commandSpec, string &targetString, const CscCommandDocGenerationContext &context = {});
 
class CSC_DLL_IMPORTEXPORT CscCommandsDocGenerator {
public:
    CscCommandsDocGenerator();
 
    vector<fs::path> generateCommandsAPIDoc(
        const fs::path &targetDirPath,
        function<bool(const CscCommandDataTypeMetadata *commandSpec)> filter = [](auto commandSpec) { return true; }) const;
};
}
 
#endif