PropertyDefinitionDoxygenFormatter Class Reference

PropertyDefinitionDoxygenFormatter creates doxygen output. More...

#include <ArmarXCore/core/application/properties/PropertyDefinitionDoxygenFormatter.h>

Inheritance diagram for PropertyDefinitionDoxygenFormatter:

Public Member Functions
std::string	formatAttribute (std::string name, std::string details) override
std::string	formatBounds (std::string min, std::string max) override
std::string	formatCaseSensitivity (std::string caseSensitivity) override
std::string	formatDefault (std::string default_) override
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
std::string	formatDescription (std::string description) override
virtual std::string	formatDocComment (const std::string &text)
std::string	formatHeader (std::string headerText) override
std::string	formatName (std::string name) override
std::string	formatRegex (std::string regex) override
std::string	formatRequirement (std::string requirement) override
std::string	formatValue (std::string value) override
std::string	formatValues (std::vector< std::string > values) override
std::string	getFormat () override
Public Member Functions inherited from PropertyDefinitionFormatter
virtual std::string	getPrefix () const
virtual void	setPrefix (std::string prefix)
virtual	~PropertyDefinitionFormatter ()

Additional Inherited Members
Protected Attributes inherited from PropertyDefinitionFormatter
std::string	prefix

Detailed Description

PropertyDefinitionDoxygenFormatter creates doxygen output.

Definition at line 40 of file PropertyDefinitionDoxygenFormatter.h.

Member Function Documentation

formatAttribute()

std::string formatAttribute ( std::string  name, std::string  details  )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 162 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the caller graph for this function:

formatBounds()

std::string formatBounds ( std::string  min, std::string  max  )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 84 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

formatCaseSensitivity()

std::string formatCaseSensitivity ( std::string  caseSensitivity )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 109 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

formatDefault()

std::string formatDefault ( std::string  default_ )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 104 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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  )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 35 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

formatDescription()

std::string formatDescription ( std::string  description )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 79 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the caller graph for this function:

formatDocComment()

std::string formatDocComment ( const std::string &  text )

virtual

Definition at line 183 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the caller graph for this function:

formatHeader()

std::string formatHeader ( std::string  headerText )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 177 of file PropertyDefinitionDoxygenFormatter.cpp.

formatName()

std::string formatName ( std::string  name )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 74 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the caller graph for this function:

formatRegex()

std::string formatRegex ( std::string  regex )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 119 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

formatRequirement()

std::string formatRequirement ( std::string  requirement )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 114 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

formatValue()

std::string formatValue ( std::string  value )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 156 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

formatValues()

std::string formatValues ( std::vector< std::string >  values )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 124 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getFormat()

std::string getFormat ( )

overridevirtual

Implements PropertyDefinitionFormatter.

Definition at line 61 of file PropertyDefinitionDoxygenFormatter.cpp.

Here is the caller graph for this function:

---

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

• ArmarXCore/core/application/properties/PropertyDefinitionDoxygenFormatter.h
• ArmarXCore/core/application/properties/PropertyDefinitionDoxygenFormatter.cpp