Sen API
Sen Libraries
Toggle main menu visibility
Loading...
Searching...
No Matches
mkdocs.h
Go to the documentation of this file.
1
// === mkdocs.h ========================================================================================================
2
// Sen Infrastructure
3
// Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
4
// See the LICENSE.txt file for more information.
5
// © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
6
// =====================================================================================================================
7
8
#ifndef SEN_LIBS_GEN_INCLUDE_SEN_GEN_MKDOCS_H
9
#define SEN_LIBS_GEN_INCLUDE_SEN_GEN_MKDOCS_H
10
11
#include "
sen/core/base/compiler_macros.h
"
12
#include "
sen/core/lang/stl_resolver.h
"
13
14
#include <memory>
15
#include <string>
16
17
namespace
sen::gen
18
{
19
22
class
MkDocsGenerator
23
{
24
SEN_NOCOPY_NOMOVE(
MkDocsGenerator
)
25
26
public
:
27
MkDocsGenerator
();
28
~MkDocsGenerator
();
29
32
[[nodiscard]] std::string
generate
(
const
sen::lang::TypeSetContext
& typeSets,
const
std::string& title);
33
34
private
:
35
class
Impl;
36
std::unique_ptr<Impl> pimpl_;
37
};
38
39
}
// namespace sen::gen
40
41
#endif
// SEN_LIBS_GEN_INCLUDE_SEN_GEN_MKDOCS_H
sen::gen::MkDocsGenerator::generate
std::string generate(const sen::lang::TypeSetContext &typeSets, const std::string &title)
Renders a single markdown document covering every type set in the supplied context....
sen::gen::MkDocsGenerator::MkDocsGenerator
MkDocsGenerator()
sen::gen::MkDocsGenerator::~MkDocsGenerator
~MkDocsGenerator()
sen::lang::TypeSetContext
The set of types used during resolution.
Definition
stl_resolver.h:51
compiler_macros.h
sen::gen
Definition
cpp.h:21
stl_resolver.h
libs
gen
include
sen
gen
mkdocs.h
Generated by
1.17.0