PropertyDefinitionDoxygenFormatter.h
Go to the documentation of this file.
1 /*
2  * This file is part of ArmarX.
3  *
4  * Copyright (C) 2011-2016, High Performance Humanoid Technologies (H2T), Karlsruhe Institute of Technology (KIT), all rights reserved.
5  *
6  * ArmarX is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  * ArmarX is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  *
18  * @package ArmarXCore::core
19  * @author Jan Issac (jan dot issac at gmx dot de)
20  * @date 2012
21  * @copyright http://www.gnu.org/licenses/gpl-2.0.txt
22  * GNU General Public License
23  */
24 
25 #pragma once
26 
28 
29 #include <string>
30 #include <vector>
31 
32 namespace armarx
33 {
34  /**
35  * @ingroup properties
36  *
37  * @class PropertyDefinitionDoxygenFormatter
38  * @brief PropertyDefinitionDoxygenFormatter creates doxygen output
39  */
42  {
43  public:
44  std::string formatDefinition(std::string name,
45  std::string description,
46  std::string min,
47  std::string max,
48  std::string default_,
49  std::string casesensitivity,
50  std::string requirement,
51  std::string reged,
52  std::vector<std::string> values, std::string value) override;
53 
54  std::string formatName(std::string name) override;
55  std::string formatDescription(std::string description) override;
56  std::string formatBounds(std::string min, std::string max) override;
57  std::string formatDefault(std::string default_) override;
58  std::string formatCaseSensitivity(std::string caseSensitivity) override;
59  std::string formatRequirement(std::string requirement) override;
60  std::string formatRegex(std::string regex) override;
61  std::string formatValue(std::string value) override;
62  std::string formatValues(std::vector<std::string> values) override;
63  std::string formatAttribute(std::string name, std::string details) override;
64 
65  std::string formatHeader(std::string headerText) override;
66 
67  std::string getFormat() override;
68 
69 
70  virtual std::string formatDocComment(const std::string& text);
71  };
72 }
73 
armarx::PropertyDefinitionDoxygenFormatter::formatValues
std::string formatValues(std::vector< std::string > values) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:124
armarx::PropertyDefinitionDoxygenFormatter
PropertyDefinitionDoxygenFormatter creates doxygen output.
Definition: PropertyDefinitionDoxygenFormatter.h:40
armarx::PropertyDefinitionDoxygenFormatter::formatRegex
std::string formatRegex(std::string regex) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:119
armarx::PropertyDefinitionDoxygenFormatter::getFormat
std::string getFormat() override
Definition: PropertyDefinitionDoxygenFormatter.cpp:61
armarx::max
std::vector< T > max(const std::vector< T > &v1, const std::vector< T > &v2)
Definition: VectorHelpers.h:267
ProsthesisInterface.values
values
Definition: ProsthesisInterface.py:190
armarx::PropertyDefinitionDoxygenFormatter::formatDescription
std::string formatDescription(std::string description) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:79
PropertyDefinitionFormatter.h
armarx::PropertyDefinitionDoxygenFormatter::formatDocComment
virtual std::string formatDocComment(const std::string &text)
Definition: PropertyDefinitionDoxygenFormatter.cpp:183
armarx::PropertyDefinitionDoxygenFormatter::formatHeader
std::string formatHeader(std::string headerText) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:177
armarx::PropertyDefinitionDoxygenFormatter::formatBounds
std::string formatBounds(std::string min, std::string max) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:84
armarx::PropertyDefinitionDoxygenFormatter::formatDefinition
std::string formatDefinition(std::string name, std::string description, std::string min, std::string max, std::string default_, std::string casesensitivity, std::string requirement, std::string reged, std::vector< std::string > values, std::string value) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:35
armarx::PropertyDefinitionDoxygenFormatter::formatName
std::string formatName(std::string name) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:74
cxxopts::value
std::shared_ptr< Value > value()
Definition: cxxopts.hpp:926
armarx::PropertyDefinitionDoxygenFormatter::formatDefault
std::string formatDefault(std::string default_) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:104
armarx::PropertyDefinitionDoxygenFormatter::formatAttribute
std::string formatAttribute(std::string name, std::string details) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:162
armarx::min
std::vector< T > min(const std::vector< T > &v1, const std::vector< T > &v2)
Definition: VectorHelpers.h:294
armarx::PropertyDefinitionDoxygenFormatter::formatValue
std::string formatValue(std::string value) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:156
armarx::PropertyDefinitionDoxygenFormatter::formatRequirement
std::string formatRequirement(std::string requirement) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:114
armarx::PropertyDefinitionFormatter
PropertyDefinitionFormatter is the base class for all formatters of PropertyDefinitions.
Definition: PropertyDefinitionFormatter.h:38
armarx
This file offers overloads of toIce() and fromIce() functions for STL container types.
Definition: ArmarXTimeserver.cpp:28
armarx::PropertyDefinitionDoxygenFormatter::formatCaseSensitivity
std::string formatCaseSensitivity(std::string caseSensitivity) override
Definition: PropertyDefinitionDoxygenFormatter.cpp:109