|
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="CoreFaudes::Generator" ctype="faudes::vGenerator"> <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 1050 of file cfl_types.h. Constructor & Destructor Documentation
Constructor. Definition at line 331 of file cfl_types.cpp.
Copy constructor. Definition at line 336 of file cfl_types.cpp.
Destructor. Definition at line 1063 of file cfl_types.h. Member Function Documentation
Get auto-register flag.
Definition at line 379 of file cfl_types.cpp.
Clear. Reimplemented from faudes::Type. Reimplemented in faudes::FunctionDefinition, faudes::TypeDefinition, and faudes::LuaFunctionDefinition. Definition at line 362 of file cfl_types.cpp.
Get corresponding C++ type.
Definition at line 375 of file cfl_types.cpp.
Std faudes type interface: assignment.
Definition at line 341 of file cfl_types.cpp.
Std faudes type interface: test equality.
Definition at line 351 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 487 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 538 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 618 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 643 of file cfl_types.cpp.
Set name of file pointing to the html documentation.
Definition at line 386 of file cfl_types.cpp.
Definition at line 377 of file cfl_types.cpp.
Definition at line 427 of file cfl_types.cpp.
Definition at line 378 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 400 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 466 of file cfl_types.cpp.
Set name.
Reimplemented from faudes::Type. Definition at line 382 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 373 of file cfl_types.cpp.
Get name of plugin. The plugin name defaults to CoreFaudes.
Definition at line 374 of file cfl_types.cpp.
Set a short textual documentation.
Definition at line 385 of file cfl_types.cpp.
Definition at line 376 of file cfl_types.cpp. Member Data Documentation
Flag to indicate automated registration. Definition at line 1335 of file cfl_types.h.
Corresponing C++ type, or "" if no such. Definition at line 1320 of file cfl_types.h.
Constant characted used to seperate keywords. Definition at line 1332 of file cfl_types.h.
String containing the filename of the corresponding html-documentation. Definition at line 1326 of file cfl_types.h.
Comma-seperated string containing all keywords. Definition at line 1329 of file cfl_types.h.
Faudes name. Definition at line 1314 of file cfl_types.h.
Faudes plugin. Definition at line 1317 of file cfl_types.h.
String containing the text-documentation. Definition at line 1323 of file cfl_types.h. The documentation for this class was generated from the following files: |
libFAUDES 2.18b --- 2010-12-17 --- c++ source docu by doxygen 1.6.3