Generated on Sun 17:08:52 for SpatiaLite by 1.8. Dont duplicate the function comments in the source (.c) files where these functions are defined. Public functions should have Doxygen commenting in the. The arrow is labelled with the template parameters of the instance. h) should include a Doxygen header block (template below). The arrow is labelled with the variable(s) through which the pointed class or struct is accessible.Ī yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. A graph is truncated if it does not fit within the specified boundaries.Ī dark blue arrow is used to visualize a public inheritance relation between two classes.Ī dark green arrow is used for protected inheritance.Ī dark red arrow is used for private inheritance.Ī purple dashed arrow is used if a class is contained or used by another class. Except for a few keywords and basic markup, the content of the comment is interpreted by the Doxygen processor as plain text. Doxygen-style comments can be placed across the source code and used for generating full-fledged documentation in various formats. The basic format for a block comment is / (slash, star, star) - this tells Doxygen that the text inside should be extracted.
The boxes in the above graph have the following meaning:Ī filled gray box represents the struct or class for which the graph is generated.Ī box with a black border denotes a documented struct or class.Ī box with a gray border denotes an undocumented struct or class.Ī box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. In the C++ world Doxygen is quite a popular tool for documenting the code.
