2.2.5. Documentation

For communication objects, structs and enumerations a *.dox file is generated automatically as soon as the model is saved. This file can be used to generate a documentation with doxygen. The documentation contains all communication objects, structs and enumerations of the CommObjectRepository with their names, attributes and a class reference. To add further information to the class reference the '@doc' keyword followed by a String has to be written on top of the communication object, struct or enumeration. The information will then be included in the documentation.

Documentation of communication objects

Figure 2.13. Documentation of communication objects


WordPress Appliance - Powered by TurnKey Linux