|
libFAUDES
Sections
Index
|
faudes::Documentation Class Referencefaudes type implementation macros, overall, debug version More...
Detailed Descriptionfaudes type implementation macros, overall, debug version Structure to hold documentation data relating to a faudes-type or -function. This class is the common base for faudes::TypeDefinition and faudes::FunctionDefinition. It supports token io as demonstrated by the follwoing example for a type defintion: <TypeDefinition> % name of this faudes-type, incl. colon separated plugin name "CoreFaudes::Generator" % corresponding C++ type (optional) +faudes::cGenerator+ % short docu <TextDoc> "The common 5 tuple G=(Sigma, Q, delta, Qo, Qm)." % html reference for documentation <HtmlDoc> "generators.html#plain" </HtmlDoc> % relevant keywords <Keywords> "generator" "language" </Keywords> </TypeDefinition> Technical detail: Documentation is derived from Type for the purpose of token IO. We still implement the faudes type interface to make it a fully qualified faudes data type. Technical detail: To facilitate inheritance, token io of member data and token io of the section tags is separated. Definition at line 913 of file cfl_types.h. Constructor & Destructor Documentation
Constructor. Definition at line 275 of file cfl_types.cpp.
Copy constructor. Definition at line 279 of file cfl_types.cpp.
Destructor. Definition at line 926 of file cfl_types.h. Member Function Documentation
Clear. Reimplemented from faudes::Type. Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 306 of file cfl_types.cpp.
Get corresponding C++ type.
Definition at line 318 of file cfl_types.cpp.
Std faudes type interface: assignment.
Definition at line 284 of file cfl_types.cpp.
Std faudes type interface: test equality.
Definition at line 295 of file cfl_types.cpp.
Read configuration data of this object from TokenReader. This virtual function reads documentation from a token stream. The section defaults to Documentation. It invokes DoReadCore to do the member data token reading.
Reimplemented from faudes::Type. Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 427 of file cfl_types.cpp.
Read configuration data of this object from TokenReader. This virtual function reads documentation member data only. It does NOT read the enclosing begin and end tokens.
Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 450 of file cfl_types.cpp.
Write configuration data of this object to TokenWriter. This virtual function writes documentation to a token stream. The section defaults to Documentation. It invokes DoWriteCore to do the actual member data writing.
Reimplemented from faudes::Type. Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 505 of file cfl_types.cpp.
Write configuration data of this object to TokenWriter. This virtual function reads documentation members only. It does NOT write enclosing begin and end tokens.
Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 518 of file cfl_types.cpp.
Set name of file pointing to the html documentation.
Definition at line 328 of file cfl_types.cpp.
Definition at line 320 of file cfl_types.cpp.
Definition at line 368 of file cfl_types.cpp.
Definition at line 321 of file cfl_types.cpp.
Search comma-seperated keywords for a substring. This should be extended to regular expressions in a future release.
Definition at line 341 of file cfl_types.cpp.
Merge documentation and from token stream. This member reads the body of a Documentation from token format and sets the documentation accordingly. An exception is thrown if the current type name differs from the one in the documentation.
Definition at line 407 of file cfl_types.cpp.
Set name.
Reimplemented from faudes::Type. Definition at line 324 of file cfl_types.cpp.
Get name of the entety to document (aka faudes-type or faudes-function).
Reimplemented from faudes::Type. Definition at line 316 of file cfl_types.cpp.
Get name of plugin. The plugin name defaults to CoreFaudes.
Definition at line 317 of file cfl_types.cpp.
Set a short textual documentation.
Definition at line 327 of file cfl_types.cpp.
Definition at line 319 of file cfl_types.cpp. Member Data Documentation
Corresponing C++ type, or "" if no such. Definition at line 1169 of file cfl_types.h.
Constant characted used to seperate keywords. Definition at line 1181 of file cfl_types.h.
String containing the filename of the corresponding html-documentation. Definition at line 1175 of file cfl_types.h.
Comma-seperated string containing all keywords. Definition at line 1178 of file cfl_types.h.
Faudes plugin. Definition at line 1166 of file cfl_types.h.
String containing the text-documentation. Definition at line 1172 of file cfl_types.h. The documentation for this class was generated from the following files: |
libFAUDES 2.16b --- 2010-9-8 --- c++ source docu by doxygen 1.6.3