forked from cepgen/cepgen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DocumentationGenerator.h
49 lines (42 loc) · 1.65 KB
/
DocumentationGenerator.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*
* CepGen: a central exclusive processes event generator
* Copyright (C) 2024 Laurent Forthomme
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef CepGen_Utils_DocumentationGenerator_h
#define CepGen_Utils_DocumentationGenerator_h
#include "CepGen/Modules/ModuleFactory.h"
namespace cepgen {
namespace utils {
/// Documentation generator object
/// \author Laurent Forthomme <laurent.forthomme@cern.ch>
/// \date Mar 2024
class DocumentationGenerator : public NamedModule<DocumentationGenerator, std::string> {
public:
explicit DocumentationGenerator(const ParametersList&);
virtual ~DocumentationGenerator() = default;
static ParametersDescription description();
virtual void initialise();
virtual std::string describe() = 0;
protected:
struct category_t {
std::string name, title, description;
std::map<std::string, ParametersDescription> modules{};
};
std::vector<std::pair<std::string, category_t> > categories_;
};
} // namespace utils
} // namespace cepgen
#endif