Tulip  6.0.0
Large graphs analysis and drawing
doxygen_groups.h
1 /**
2  *
3  * This file is part of Tulip (https://tulip.labri.fr)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 
20 /*
21  * Note for developers
22  *
23  * When writing the doxygen documentation for a class, one should follow those steps:
24  *
25  * 1/ Remove the @cond DOXYGEN_HIDDEN condition on top of the header and the @endcond tag at the bottom.
26  * If you are adding a new class to Tulip and didn't write the documentation yet, you should add those tags until the documentation is written.
27  * 2/ Every class should belong to a doxygen group. This means that a @ingroup declaration must be added before the class @brief tag.
28  * 3/ A doxygen group is identified by a single-word identifier (first word after the @defgroup declaration). What follows in the @defgroup declaration is the pretty name that will appear into the final HTML document.
29  * 3/ Definitions for doxygen groups are found in this file.
30  * 4/ Code examples and tutorials belong in this directory too. There should be one header per tutorial to ease documentation process.
31  * 5/ Please remember that code comments should NEVER begin with /** (use /* instead) in order to exclude them from doxygen.
32  */
33 
34 /**
35  * @mainpage Welcome to Tulip's documentation.
36  * You can jump right in with \ref graph_display/graph_display.cpp "one of our code examples", or browse the documentation by module.
37  *
38  * See for instance the documentation for the @ref Graph.
39  */
40 
41 /**
42  * @defgroup Checks Model Checking
43  * @brief Graph model checking
44  * Classes in this group allow to perform various checks on a graph data structure.
45  */
46 
47 /**
48  * @defgroup Structures Data structures
49  * @brief Tulip basic data structures
50  */
51 
52 /**
53  * @defgroup Graph Graph model
54  * @brief Tulip graphs manipulation system
55  * Classes in this group are related to the core system of Graph manipulation.
56  */
57 
58 /**
59  * @defgroup Observation Observation system
60  * @brief Tulip observer pattern implementation
61  * Classes in this group are involved in the observation system.
62  */
63 
64 /**
65  * @defgroup OpenGL 3D graph rendering
66  * @brief OpenGL graph rendering
67  * Classes in this group are related to the OpenGL rendering of graphs and to the OpenGL augmented display
68  */
69 
70 /**
71  * @defgroup Plugins Plugins system
72  * @brief Tulip plugins interfaces
73  * Classes in this group are interfaces for the plugins system. You will subclass one of them when creating your own Tulip plugins.
74  */