PropertyDefinitionDoxygenComponentPagesFormatter creates doxygen output with an own group for every component. More...

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

Inheritance diagram for PropertyDefinitionDoxygenComponentPagesFormatter:

Public Member Functions
std::string	formatAttribute (std::string name, std::string details) 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	formatValues (std::vector< std::string > values) override

std::string	getFormat () override

	PropertyDefinitionDoxygenComponentPagesFormatter ()

Public Member Functions inherited from PropertyDefinitionDoxygenFormatter
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

PropertyDefinitionDoxygenComponentPagesFormatter creates doxygen output with an own group for every component.

Constructor & Destructor Documentation

◆ PropertyDefinitionDoxygenComponentPagesFormatter()

PropertyDefinitionDoxygenComponentPagesFormatter ( )

inline

Member Function Documentation

◆ formatAttribute()

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

overridevirtual

Implements PropertyDefinitionFormatter.

◆ 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 )