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="CoreFaudes::Generator" ctype="faudes::Generator"> <Documentation ref="generators.html#plain"> The common 5 tuple G=(Sigma, Q, delta, Qo, Qm). <Documentation/> <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 1062 of file cfl_types.h. Constructor & Destructor Documentation
Constructor. Definition at line 352 of file cfl_types.cpp.
Copy constructor. Definition at line 358 of file cfl_types.cpp.
Destructor. Definition at line 1075 of file cfl_types.h. Member Function Documentation
Set application-registered flag. See also AutoRegistered(void)
Definition at line 412 of file cfl_types.cpp.
Get application-registered flag.
Definition at line 403 of file cfl_types.cpp.
Set auto-register flag. See also AutoRegistered(void)
Definition at line 411 of file cfl_types.cpp.
Get auto-register flag. This flag indicated that the respective type was (will be) registered by a libFAUDES static initialisation protorype.
Definition at line 402 of file cfl_types.cpp.
Clear. Reimplemented from faudes::Type. Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 384 of file cfl_types.cpp.
Get corresponding C++ type.
Definition at line 398 of file cfl_types.cpp.
Std faudes type interface: assignment.
Definition at line 363 of file cfl_types.cpp.
Std faudes type interface: test equality.
Definition at line 373 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 513 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 564 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 644 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 669 of file cfl_types.cpp.
Set name of file pointing to the html documentation.
Definition at line 410 of file cfl_types.cpp.
Definition at line 400 of file cfl_types.cpp.
Definition at line 452 of file cfl_types.cpp.
Definition at line 401 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 425 of file cfl_types.cpp.
Merge documentation from token stream. An exception is thrown if the current type name differs from the one in the documentation.
Definition at line 491 of file cfl_types.cpp.
Set name.
Reimplemented from faudes::Type. Definition at line 406 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 396 of file cfl_types.cpp.
Get name of plugin. The plugin name defaults to CoreFaudes.
Definition at line 397 of file cfl_types.cpp.
Set a short textual documentation.
Definition at line 409 of file cfl_types.cpp.
Definition at line 399 of file cfl_types.cpp. Member Data Documentation
Flag to indicate application registration. Definition at line 1373 of file cfl_types.h.
Flag to indicate automated registration. Definition at line 1370 of file cfl_types.h.
Corresponing C++ type, or "" if no such. Definition at line 1355 of file cfl_types.h.
Constant characted used to seperate keywords. Definition at line 1367 of file cfl_types.h.
String containing the filename of the corresponding html-documentation. Definition at line 1361 of file cfl_types.h.
Comma-seperated string containing all keywords. Definition at line 1364 of file cfl_types.h.
Faudes name. Definition at line 1349 of file cfl_types.h.
Faudes plugin. Definition at line 1352 of file cfl_types.h.
String containing the text-documentation. Definition at line 1358 of file cfl_types.h. The documentation for this class was generated from the following files: libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen |