Fine tuned the doxygen commands.

pgmodeler · Jan 29, 2013 · 5365853 · 5365853
1 parent 2b14294
commit 5365853
Show file tree

Hide file tree

Showing 107 changed files with 822 additions and 439 deletions.
diff --git a/crashhandler/src/crashhandler.h b/crashhandler/src/crashhandler.h
@@ -1,9 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: crashhandler
-# Classe: CrashHandler
-# Description: Implements the pgModeler's crash handler enabling the generation an analysis
-#              of crash report files.
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -19,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup crashhandler
+\class CrashHandler
+\brief Implements the pgModeler's crash handler enabling the generation an analysis of crash report files.
+*/
+
 #ifndef CRASH_HANDLER_H
 #define CRASH_HANDLER_H
 

diff --git a/libdbconnect/src/dbconnection.h b/libdbconnect/src/dbconnection.h
@@ -1,10 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: libdbconnect library
-# Class: DBConnection
-# Description: This class encapsulates some connection manipulation functions
-#              implemented by the PostgreSQL libpq
-# Creation date: 13/07/2009
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -20,6 +15,14 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libdbconnect
+\class DBConnection
+\brief This class encapsulates some connection manipulation functions implemented by the PostgreSQL libpq
+\note <strong>Creation date:</strong> 13/07/2009
+*/
+
 #ifndef DBCONNECTION_H
 #define DBCONNECTION_H
 

diff --git a/libdbconnect/src/resultset.h b/libdbconnect/src/resultset.h
@@ -1,10 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: libdbconnect library
-# Class: ResultSet
-# Description: This class encapsulates some functions implemented by libpq
-#              for manipulation of resultsets returned by PostgreSQL SQL commands
-# Creation date: 14/07/2009
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -20,6 +15,14 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libdbconnect
+\class ResultSet
+\brief This class encapsulates some functions implemented by libpq for manipulation of resultsets returned by PostgreSQL SQL commands
+\note <strong>Creation date:</strong> 14/07/2009
+*/
+
 #ifndef RESULTSET_H
 #define RESULTSET_H
 

diff --git a/libobjrenderer/src/baseobjectview.h b/libobjrenderer/src/baseobjectview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: BaseObjectView
-# Description: Implements the basic routines to graphically represent the objects: table, relationship, textbox, view
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class BaseObjectView
+\brief Implements the basic routines to graphically represent the objects: table, relationship, textbox, view.
+*/
+
 #ifndef BASE_OBJECT_VIEW_H
 #define BASE_OBJECT_VIEW_H
 

diff --git a/libobjrenderer/src/basetableview.h b/libobjrenderer/src/basetableview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: BaseTableView
-# Description: Base class shared by the classes TableView and GraphicalView
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class BaseTableView
+\brief Base class shared by the classes TableView and GraphicalView
+*/
+
 #ifndef BASE_TABLE_VIEW_H
 #define BASE_TABLE_VIEW_H
 

diff --git a/libobjrenderer/src/graphicalview.h b/libobjrenderer/src/graphicalview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Classe: GraphicalView
-# Description: Implements the graphical representation for Views
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class GraphicalView
+\brief Implements the graphical representation for Views
+*/
+
 #ifndef GRAPHICAL_VIEW_H
 #define GRAPHICAL_VIEW_H
 

diff --git a/libobjrenderer/src/objectsscene.h b/libobjrenderer/src/objectsscene.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: ObjectsScene
-# Description: Implements the basic operations to visualize and manipulate the graphical objects.
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class ObjectsScene
+\brief Implements the basic operations to visualize and manipulate the graphical objects.
+*/
+
 #ifndef OBJECTS_SCENE_H
 #define OBJECTS_SCENE_H
 

diff --git a/libobjrenderer/src/relationshipview.h b/libobjrenderer/src/relationshipview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: RelationshipView
-# Description: Implements the graphical representation for relationships
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class RelationshipView
+\brief Implements the graphical representation for relationships
+*/
+
 #ifndef RELATIONSHIP_VIEW_H
 #define RELATIONSHIP_VIEW_H
 

diff --git a/libobjrenderer/src/schemaview.h b/libobjrenderer/src/schemaview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: TextboxView
-# Description: Represents the textbox in a graphical way on the object scene
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class TextboxView
+\brief Represents the textbox in a graphical way on the object scene
+*/
+
 #ifndef SCHEMA_VIEW_H
 #define SCHEMA_VIEW_H
 

diff --git a/libobjrenderer/src/tableobjectview.h b/libobjrenderer/src/tableobjectview.h
@@ -1,9 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: TableObjectView
-# Description: implements the graphical representation for table objects (columns, constraints, triggers,
-#              rules, indexes) as well the view references
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -19,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class TableObjectView
+\brief implements the graphical representation for table objects (columns, constraints, triggers, rules, indexes) as well the view references
+*/
+
 #ifndef TABLE_OBJECT_VIEW_H
 #define TABLE_OBJECT_VIEW_H
 

diff --git a/libobjrenderer/src/tabletitleview.h b/libobjrenderer/src/tabletitleview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Classe: TableTitleView
-# Description: Implements the graphical representation for table title
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class TableTitleView
+\brief Implements the graphical representation for table title
+*/
+
 #ifndef TABLE_TITLE_VIEW_H
 #define TABLE_TITLE_VIEW_H
 

diff --git a/libobjrenderer/src/tableview.h b/libobjrenderer/src/tableview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: TableView
-# Description: Implements the graphical representation for tables.
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class TableView
+\brief Implements the graphical representation for tables.
+*/
+
 #ifndef TABLE_VIEW_H
 #define TABLE_VIEW_H
 

diff --git a/libobjrenderer/src/textboxview.h b/libobjrenderer/src/textboxview.h
@@ -1,8 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Graphical objects renderer (libobjrenderer)
-# Class: TextboxView
-# Description: Represents the textbox in a graphical way on the object scene
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -18,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libobjrenderer
+\class TextboxView
+\brief Represents the textbox in a graphical way on the object scene
+*/
+
 #ifndef TEXTBOX_VIEW_H
 #define TEXTBOX_VIEW_H
 

diff --git a/libparsers/src/schemaparser.h b/libparsers/src/schemaparser.h
@@ -1,9 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Parsers library (libparsers)
-# Description: ParserEsquema class definition used to create SQL definition
-#              for model objects from schemas files (stored on disk).
-# Creation date: 19/06/2008
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -19,6 +15,13 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libparsers
+\brief ParserEsquema class definition used to create SQL definition for model objects from schemas files (stored on disk).
+\note <strong>Creation date:</strong> 19/06/2008
+*/
+
 #ifndef SCHEMA_PARSER_H
 #define SCHEMA_PARSER_H
 

diff --git a/libparsers/src/xmlparser.h b/libparsers/src/xmlparser.h
@@ -1,10 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Parsers library (libparsers)
-# Classe: XMLParser
-# Description: This class implements basic operations of an xml analyzer
-#              encapsulating some functions implemented by libxml2 library
-# Creation date: 02/04/2008
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -20,6 +15,14 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libparsers
+\class XMLParser
+\brief This class implements basic operations of a xml analyzer encapsulating some functions implemented by libxml2 library
+\note <strong>Creation date:</strong> 02/04/2008
+*/
+
 #ifndef XML_PARSER_H
 #define XML_PARSER_H
 

diff --git a/libpgmodeler/src/aggregate.h b/libpgmodeler/src/aggregate.h
@@ -1,9 +1,5 @@
 /*
 # PostgreSQL Database Modeler (pgModeler)
-# Sub-project: Core library (libpgmodeler)
-# Class: Aggregate
-# Description: Implements the operations to manipulate aggregates on the database.
-# Creation date: 16/04/2008
 #
 # Copyright 2006-2013 - Raphael Araújo e Silva <rkhaotix@gmail.com>
 #
@@ -19,6 +15,14 @@
 # The complete text of GPLv3 is at LICENSE file on source code root directory.
 # Also, you can get the complete GNU General Public License at <http://www.gnu.org/licenses/>
 */
+
+/**
+\ingroup libpgmodeler
+\class Aggregate
+\brief Implements the operations to manipulate aggregates on the database.
+\note <strong>Creation date:</strong> 16/04/2008
+**/
+
 #ifndef AGGREGATE_H
 #define AGGREGATE_H