From 53658533c4d010340a3d2a29dca425b57efd4080 Mon Sep 17 00:00:00 2001 From: "Raphael A. Silva" Date: Tue, 29 Jan 2013 12:32:24 -0300 Subject: [PATCH] Fine tuned the doxygen commands. --- crashhandler/src/crashhandler.h | 11 +++++++---- libdbconnect/src/dbconnection.h | 13 ++++++++----- libdbconnect/src/resultset.h | 13 ++++++++----- libobjrenderer/src/baseobjectview.h | 10 +++++++--- libobjrenderer/src/basetableview.h | 10 +++++++--- libobjrenderer/src/graphicalview.h | 10 +++++++--- libobjrenderer/src/objectsscene.h | 10 +++++++--- libobjrenderer/src/relationshipview.h | 10 +++++++--- libobjrenderer/src/schemaview.h | 10 +++++++--- libobjrenderer/src/tableobjectview.h | 11 +++++++---- libobjrenderer/src/tabletitleview.h | 10 +++++++--- libobjrenderer/src/tableview.h | 10 +++++++--- libobjrenderer/src/textboxview.h | 10 +++++++--- libparsers/src/schemaparser.h | 11 +++++++---- libparsers/src/xmlparser.h | 13 ++++++++----- libpgmodeler/src/aggregate.h | 12 ++++++++---- libpgmodeler/src/basegraphicobject.h | 17 ++++++++++------- libpgmodeler/src/baseobject.h | 14 ++++++++------ libpgmodeler/src/baserelationship.h | 12 ++++++++---- libpgmodeler/src/basetable.h | 12 ++++++++---- libpgmodeler/src/cast.h | 13 ++++++++----- libpgmodeler/src/column.h | 12 ++++++++---- libpgmodeler/src/constraint.h | 13 ++++++++----- libpgmodeler/src/conversion.h | 13 ++++++++----- libpgmodeler/src/databasemodel.h | 15 +++++++++------ libpgmodeler/src/domain.h | 12 ++++++++---- libpgmodeler/src/function.h | 11 +++++++---- libpgmodeler/src/index.h | 12 ++++++++---- libpgmodeler/src/indexelement.h | 14 +++++++++----- libpgmodeler/src/language.h | 12 ++++++++---- libpgmodeler/src/operationlist.h | 17 ++++++++++------- libpgmodeler/src/operator.h | 10 +++++++--- libpgmodeler/src/operatorclass.h | 16 ++++++++++------ libpgmodeler/src/operatorclasselement.h | 14 +++++++++----- libpgmodeler/src/operatorfamily.h | 12 ++++++++---- libpgmodeler/src/permission.h | 12 ++++++++---- libpgmodeler/src/pgsqltypes.h | 10 +++++++--- libpgmodeler/src/reference.h | 12 ++++++++---- libpgmodeler/src/relationship.h | 14 +++++++++----- libpgmodeler/src/role.h | 12 ++++++++---- libpgmodeler/src/rule.h | 12 ++++++++---- libpgmodeler/src/schema.h | 14 +++++++++----- libpgmodeler/src/sequence.h | 12 ++++++++---- libpgmodeler/src/table.h | 10 +++++++--- libpgmodeler/src/tableobject.h | 14 +++++++++----- libpgmodeler/src/tablespace.h | 13 ++++++++----- libpgmodeler/src/textbox.h | 14 +++++++++----- libpgmodeler/src/trigger.h | 12 ++++++++---- libpgmodeler/src/type.h | 12 ++++++++---- libpgmodeler/src/view.h | 10 +++++++--- libpgmodeler_ui/src/appearanceconfigwidget.h | 10 +++++++--- libpgmodeler_ui/src/baseconfigwidget.h | 10 +++++++--- libpgmodeler_ui/src/baseobjectwidget.h | 10 +++++++--- libpgmodeler_ui/src/castwidget.h | 10 +++++++--- libpgmodeler_ui/src/columnwidget.h | 10 +++++++--- libpgmodeler_ui/src/connectionsconfigwidget.h | 10 +++++++--- libpgmodeler_ui/src/conversionwidget.h | 10 +++++++--- libpgmodeler_ui/src/databasewidget.h | 10 +++++++--- libpgmodeler_ui/src/dominiowidget.h | 11 +++++++---- libpgmodeler_ui/src/espacotabelawidget.h | 11 +++++++---- libpgmodeler_ui/src/esquemawidget.h | 11 +++++++---- libpgmodeler_ui/src/familiaoperadoreswidget.h | 11 +++++++---- libpgmodeler_ui/src/formbasico.h | 11 +++++++---- libpgmodeler_ui/src/formconfiguracao.h | 10 +++++++--- libpgmodeler_ui/src/formexportacao.h | 10 +++++++--- libpgmodeler_ui/src/formprincipal.h | 12 ++++++++---- libpgmodeler_ui/src/formrestauracaomodelo.h | 10 +++++++--- libpgmodeler_ui/src/formsobre.h | 10 +++++++--- libpgmodeler_ui/src/funcaoagregacaowidget.h | 12 ++++++++---- libpgmodeler_ui/src/funcaowidget.h | 11 +++++++---- libpgmodeler_ui/src/gatilhowidget.h | 11 +++++++---- libpgmodeler_ui/src/generalconfigwidget.h | 14 +++++++++----- libpgmodeler_ui/src/indicewidget.h | 11 +++++++---- libpgmodeler_ui/src/linguagemwidget.h | 11 +++++++---- libpgmodeler_ui/src/listaobjetoswidget.h | 11 +++++++---- libpgmodeler_ui/src/listaoperacoeswidget.h | 11 +++++++---- libpgmodeler_ui/src/messagebox.h | 10 +++++++--- libpgmodeler_ui/src/modelowidget.h | 14 +++++++++----- libpgmodeler_ui/src/operadorwidget.h | 11 +++++++---- libpgmodeler_ui/src/operatorclasswidget.h | 10 +++++++--- libpgmodeler_ui/src/papelwidget.h | 11 +++++++---- libpgmodeler_ui/src/parametrowidget.h | 12 +++++++----- libpgmodeler_ui/src/permissaowidget.h | 11 +++++++---- libpgmodeler_ui/src/pgmodelerplugin.h | 13 ++++++++----- libpgmodeler_ui/src/pluginsconfigwidget.h | 10 +++++++--- libpgmodeler_ui/src/progressotarefa.h | 11 +++++++---- libpgmodeler_ui/src/quickrenamewidget.h | 10 +++++++--- libpgmodeler_ui/src/regrawidget.h | 11 +++++++---- libpgmodeler_ui/src/relacionamentowidget.h | 11 +++++++---- libpgmodeler_ui/src/restricaowidget.h | 11 +++++++---- libpgmodeler_ui/src/seletorobjetowidget.h | 17 ++++++++++------- libpgmodeler_ui/src/sequenciawidget.h | 11 +++++++---- libpgmodeler_ui/src/sourcecodewidget.h | 10 +++++++--- libpgmodeler_ui/src/syntaxhighlighter.h | 12 ++++++++---- libpgmodeler_ui/src/tabelaobjetoswidget.h | 18 +++++++++++------- libpgmodeler_ui/src/tabelawidget.h | 11 +++++++---- libpgmodeler_ui/src/textboxwidget.h | 10 +++++++--- libpgmodeler_ui/src/tipopgsqlwidget.h | 18 +++++++++++------- libpgmodeler_ui/src/tipowidget.h | 11 +++++++---- libpgmodeler_ui/src/visaogeralwidget.h | 10 +++++++--- libpgmodeler_ui/src/visaoobjetoswidget.h | 11 +++++++---- libpgmodeler_ui/src/visaowidget.h | 11 +++++++---- libutil/src/exception.h | 11 ++++++++--- libutil/src/globalattributes.h | 15 +++++++++------ libutil/src/parsersattributes.h | 18 ++++++++++-------- main/src/application.h | 14 +++++++++----- plugins/dummyplugin/src/dummyplugin.h | 10 +++++++--- 107 files changed, 822 insertions(+), 439 deletions(-) diff --git a/crashhandler/src/crashhandler.h b/crashhandler/src/crashhandler.h index 9e21b2648..b2557ad5c 100644 --- 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 # @@ -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 */ + +/** +\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 index 5010d32e6..6eeadb165 100644 --- 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 # @@ -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 */ + +/** +\ingroup libdbconnect +\class DBConnection +\brief This class encapsulates some connection manipulation functions implemented by the PostgreSQL libpq +\note Creation date: 13/07/2009 +*/ + #ifndef DBCONNECTION_H #define DBCONNECTION_H diff --git a/libdbconnect/src/resultset.h b/libdbconnect/src/resultset.h index e3ac64f32..e8fb0f3cb 100644 --- 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 # @@ -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 */ + +/** +\ingroup libdbconnect +\class ResultSet +\brief This class encapsulates some functions implemented by libpq for manipulation of resultsets returned by PostgreSQL SQL commands +\note Creation date: 14/07/2009 +*/ + #ifndef RESULTSET_H #define RESULTSET_H diff --git a/libobjrenderer/src/baseobjectview.h b/libobjrenderer/src/baseobjectview.h index f06bc6818..a44e82862 100644 --- 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 # @@ -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 */ + +/** +\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 index 5b24a2ac2..bde999963 100644 --- 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 # @@ -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 */ + +/** +\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 index 38b4fbb71..b235617c3 100644 --- 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 # @@ -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 */ + +/** +\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 index 146efb789..a035e0be1 100644 --- 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 # @@ -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 */ + +/** +\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 index 199981f2b..66cc855b9 100644 --- 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 # @@ -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 */ + +/** +\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 index 61a7b64d2..84807cacd 100644 --- 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 # @@ -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 */ + +/** +\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 index 6ba9f8197..fbfb0c455 100644 --- 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 # @@ -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 */ + +/** +\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 index 24f4809a2..a9491bafa 100644 --- 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 # @@ -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 */ + +/** +\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 index 002add6a3..fd0135a03 100644 --- 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 # @@ -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 */ + +/** +\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 index 5ee83f188..fd0180d1b 100644 --- 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 # @@ -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 */ + +/** +\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 index b4c5448b2..466a6e531 100644 --- 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 # @@ -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 */ + +/** +\ingroup libparsers +\brief ParserEsquema class definition used to create SQL definition for model objects from schemas files (stored on disk). +\note Creation date: 19/06/2008 +*/ + #ifndef SCHEMA_PARSER_H #define SCHEMA_PARSER_H diff --git a/libparsers/src/xmlparser.h b/libparsers/src/xmlparser.h index eebbb5741..f5047c46f 100644 --- 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 # @@ -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 */ + +/** +\ingroup libparsers +\class XMLParser +\brief This class implements basic operations of a xml analyzer encapsulating some functions implemented by libxml2 library +\note Creation date: 02/04/2008 +*/ + #ifndef XML_PARSER_H #define XML_PARSER_H diff --git a/libpgmodeler/src/aggregate.h b/libpgmodeler/src/aggregate.h index 0f17224c7..d11d85c91 100644 --- 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 # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Aggregate +\brief Implements the operations to manipulate aggregates on the database. +\note Creation date: 16/04/2008 +**/ + #ifndef AGGREGATE_H #define AGGREGATE_H diff --git a/libpgmodeler/src/basegraphicobject.h b/libpgmodeler/src/basegraphicobject.h index 6db8b40be..710dd7d8b 100644 --- a/libpgmodeler/src/basegraphicobject.h +++ b/libpgmodeler/src/basegraphicobject.h @@ -1,12 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: BaseGraphicObject -# Description: This is a basic implementation to control graphical objects such as -# tables, relationships, textboxes, views. -# The full graphical representation of these objects are made in an separated layer -# this is treated in the GraphicObject class on libobjrenderer library -# Creation date: 17/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -22,6 +15,16 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class BaseGraphicObject +\brief This is a basic implementation to control graphical objects such as tables, relationships, textboxes, views. +The full graphical representation of these objects are made in an separated layer +this is treated in the BaseObjectView class on libobjrenderer library +\note Creation date: 17/09/2006 +*/ + #ifndef BASE_GRAPHIC_OBJECT_H #define BASE_GRAPHIC_OBJECT_H diff --git a/libpgmodeler/src/baseobject.h b/libpgmodeler/src/baseobject.h index 64013dfff..35614df44 100644 --- a/libpgmodeler/src/baseobject.h +++ b/libpgmodeler/src/baseobject.h @@ -1,11 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: BaseObject -# Description: Implements the most important operations to define, -# maintain and generate code (SQL or XML) of database objects -# Creation date: 12/09/2006 -# # Copyright 2006-2013 - Raphael Araújo e Silva # # This program is free software: you can redistribute it and/or modify @@ -20,6 +14,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 */ + +/** +\class BaseObject +\brief Implements the most important operations to define, maintain and generate code (SQL or XML) of database objects +\note Creation date: 12/09/2006 +\ingroup libpgmodeler +*/ + #ifndef BASE_OBJECT_H #define BASE_OBJECT_H diff --git a/libpgmodeler/src/baserelationship.h b/libpgmodeler/src/baserelationship.h index 332c7a3da..536fad51c 100644 --- a/libpgmodeler/src/baserelationship.h +++ b/libpgmodeler/src/baserelationship.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: BaseRelationship -# Description: Implements the basic operations to manipulate relationships between tables -# Creation date: 09/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class BaseRelationship +\brief Implements the basic operations to manipulate relationships between tables +\note Creation date: 09/04/2008 +*/ + #ifndef BASE_RELATIONSHIP_H #define BASE_RELATIONSHIP_H diff --git a/libpgmodeler/src/basetable.h b/libpgmodeler/src/basetable.h index 4d442ea94..19ea45e63 100644 --- a/libpgmodeler/src/basetable.h +++ b/libpgmodeler/src/basetable.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: BaseTable -# Description: Base class used to define table like objects (views and tables) -# Creation date: 09/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class BaseTable +\brief Base class used to define table like objects (views and tables) +\note Creation date: 09/04/2008 +*/ + #ifndef BASE_TABLE_H #define BASE_TABLE_H diff --git a/libpgmodeler/src/cast.h b/libpgmodeler/src/cast.h index 71fb79e62..75dcc78f7 100644 --- a/libpgmodeler/src/cast.h +++ b/libpgmodeler/src/cast.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Cast -# Description: Implements the operations to manipulate data type cast -# on the database -# Creation date: 03/06/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Cast +\brief Implements the operations to manipulate data type cast on the database +\note Creation date: 03/06/2008 +*/ + #ifndef CAST_H #define CAST_H diff --git a/libpgmodeler/src/column.h b/libpgmodeler/src/column.h index 2634c8e0b..038e792e8 100644 --- a/libpgmodeler/src/column.h +++ b/libpgmodeler/src/column.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Column -# Description: Implements basic operations to manipulate table columns. -# Creation date: 12/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Column +\brief Implements basic operations to manipulate table columns. +\note Creation date: 12/09/2006 +*/ + #ifndef COLUMN_H #define COLUMN_H diff --git a/libpgmodeler/src/constraint.h b/libpgmodeler/src/constraint.h index 6c61ffdbf..c80a8dd20 100644 --- a/libpgmodeler/src/constraint.h +++ b/libpgmodeler/src/constraint.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Constraint -# Description: Implements the operations to manipulate table constraints -# (primary keys, foreign key, unique and check). -# Creation date: 17/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Constraint +\brief Implements the operations to manipulate table constraints (primary keys, foreign key, unique and check). +\note Creation date: 17/09/2006 +*/ + #ifndef CONSTRAINT_H #define CONSTRAINT_H diff --git a/libpgmodeler/src/conversion.h b/libpgmodeler/src/conversion.h index 4051d7a4b..2288cac9b 100644 --- a/libpgmodeler/src/conversion.h +++ b/libpgmodeler/src/conversion.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Conversion -# Description: Implements the operations to manipulate character encoding -# conversion on the database -# Creation date: 04/06/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Conversion +\brief Implements the operations to manipulate character encoding conversion on the database +\note Creation date: 04/06/2008 +*/ + #ifndef CONVERSION_H #define CONVERSION_H diff --git a/libpgmodeler/src/databasemodel.h b/libpgmodeler/src/databasemodel.h index 19cff52b1..bddc9609d 100644 --- a/libpgmodeler/src/databasemodel.h +++ b/libpgmodeler/src/databasemodel.h @@ -1,11 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: DatabaseModel -# Description: This class reunites and manages all the other object types. -# Additionally, this class, saves, loads and generates the -# XML/SQL definition of a complete database. -# Creation date: 20/10/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -21,6 +15,15 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class DatabaseModel +\brief This class reunites and manages all the other object types. +Additionally, this class, saves, loads and generates the XML/SQL definition of a complete database. +\note Creation date: 20/10/2006 +*/ + #ifndef DATABASE_MODEL_H #define DATABASE_MODEL_H diff --git a/libpgmodeler/src/domain.h b/libpgmodeler/src/domain.h index 2a909b5d5..63369a0e9 100644 --- a/libpgmodeler/src/domain.h +++ b/libpgmodeler/src/domain.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Domain -# Description: Implements the operations to manipulate domains on the database. -# Creation date: 07/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Domain +\brief Implements the operations to manipulate domains on the database. +\note Creation date: 07/04/2008 +*/ + #ifndef DOMAIN_H #define DOMAIN_H diff --git a/libpgmodeler/src/function.h b/libpgmodeler/src/function.h index 1621f870e..b02179016 100644 --- a/libpgmodeler/src/function.h +++ b/libpgmodeler/src/function.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Description: Implements the operations to manipulate stored -# procedures (function) on the database. -# Creation date: 28/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\brief Implements the operations to manipulate stored procedures (function) on the database. +\note Creation date: 28/09/2006 +*/ + #ifndef FUNCTION_H #define FUNCTION_H diff --git a/libpgmodeler/src/index.h b/libpgmodeler/src/index.h index 6e868778f..b790b9f33 100644 --- a/libpgmodeler/src/index.h +++ b/libpgmodeler/src/index.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Index -# Description: Implements the operations to manipulate indexes on the database. -# Creation date: 23/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Index +\brief Implements the operations to manipulate indexes on the database. +\note Creation date: 23/09/2006 +*/ + #ifndef INDEX_H #define INDEX_H diff --git a/libpgmodeler/src/indexelement.h b/libpgmodeler/src/indexelement.h index f0e8f8e09..0816a8dcd 100644 --- a/libpgmodeler/src/indexelement.h +++ b/libpgmodeler/src/indexelement.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Description: Implements the operations to manipulate index elements. -# Creation date: 26/05/2010 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -18,8 +15,15 @@ # 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 */ -#ifndef ELEMENTO_INDICE_H -#define ELEMENTO_INDICE_H + +/** +\ingroup libpgmodeler +\brief Implements the operations to manipulate index elements. +\note Creation date: 26/05/2010 +*/ + +#ifndef INDEX_ELEMENT_H +#define INDEX_ELEMENT_H #include "column.h" #include "operatorclass.h" diff --git a/libpgmodeler/src/language.h b/libpgmodeler/src/language.h index c58ed63d0..7c7a0d707 100644 --- a/libpgmodeler/src/language.h +++ b/libpgmodeler/src/language.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Language -# Description: Implements the operations to manipulate procedural languages on the database. -# Creation date: 19/05/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Language +\brief Implements the operations to manipulate procedural languages on the database. +\note Creation date: 19/05/2008 +*/ + #ifndef LANGUAGE_H #define LANGUAGE_H diff --git a/libpgmodeler/src/operationlist.h b/libpgmodeler/src/operationlist.h index 32dfdbd82..f674db634 100644 --- a/libpgmodeler/src/operationlist.h +++ b/libpgmodeler/src/operationlist.h @@ -1,12 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: OperationList -# Description: Implements the operations to maintain a list of modifications made -# by the user on database model objects. This class permits that user -# undo / redo all the operations made. -# -# Creation date: 17/07/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -22,6 +15,16 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class OperationList +\brief Implements the operations to maintain a list of modifications made +by the user on database model objects. This class permits that user +undo / redo all the operations made. +\note Creation date: 17/07/2006 +*/ + #ifndef OPERATIONLIST_H #define OPERATIONLIST_H diff --git a/libpgmodeler/src/operator.h b/libpgmodeler/src/operator.h index 163127d93..ee5cca191 100644 --- a/libpgmodeler/src/operator.h +++ b/libpgmodeler/src/operator.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Description: Implements the operations to manipulate operators on the database. -# Creation date: 16/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\brief Implements the operations to manipulate operators on the database. +\note Creation date: 16/04/2008 +*/ + #ifndef OPERATOR_H #define OPERATOR_H diff --git a/libpgmodeler/src/operatorclass.h b/libpgmodeler/src/operatorclass.h index ff0a43960..cfc9c3644 100644 --- a/libpgmodeler/src/operatorclass.h +++ b/libpgmodeler/src/operatorclass.h @@ -1,11 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: OperatorClass -# Description: This class is used to generate the XML/SQL code related to PostgreSQL -# operator classes. This type of object indicates to RDBMS how a data type -# can be used in a particular indexing method. -# Creation date: 08/07/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -21,6 +15,16 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class OperatorClass +\brief This class is used to generate the XML/SQL code related to PostgreSQL +operator classes. This type of object indicates to RDBMS how a data type +can be used in a particular indexing method. +\note Creation date: 08/07/2008 +*/ + #ifndef OPERATOR_CLASS_H #define OPERATOR_CLASS_H diff --git a/libpgmodeler/src/operatorclasselement.h b/libpgmodeler/src/operatorclasselement.h index a7b7dfad1..a86909e03 100644 --- a/libpgmodeler/src/operatorclasselement.h +++ b/libpgmodeler/src/operatorclasselement.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: OperatorClassElement -# Description: Implements the operations to manipulate operator class -# elements (storage, operator, function). -# Creation date: 08/07/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -20,6 +15,15 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class OperatorClassElement +\brief Implements the operations to manipulate operator class + elements (storage, operator, function). +\note Creation date: 08/07/2008 +*/ + #ifndef OPERATOR_CLASS_ELEMENT_H #define OPERATOR_CLASS_ELEMENT_H diff --git a/libpgmodeler/src/operatorfamily.h b/libpgmodeler/src/operatorfamily.h index b507eb2b6..f9117c87b 100644 --- a/libpgmodeler/src/operatorfamily.h +++ b/libpgmodeler/src/operatorfamily.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: OperatorFamily -# Description: Implements the operations to manipulate operator family on the database. -# Creation date: 08/07/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class OperatorFamily +\brief Implements the operations to manipulate operator family on the database. +\note Creation date: 08/07/2008 +*/ + #ifndef OPERATOR_FAMILY_H #define OPERATOR_FAMILY_H diff --git a/libpgmodeler/src/permission.h b/libpgmodeler/src/permission.h index de816a765..fd61f99cc 100644 --- a/libpgmodeler/src/permission.h +++ b/libpgmodeler/src/permission.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Permission -# Description: Implements the operations to manipulate object permissions. -# Creation date: 16/09/2010 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Permission +\brief Implements the operations to manipulate object permissions. +\note Creation date: 16/09/2010 +*/ + #ifndef PERMISSION_H #define PERMISSION_H diff --git a/libpgmodeler/src/pgsqltypes.h b/libpgmodeler/src/pgsqltypes.h index 9e4179172..dbe7826eb 100644 --- a/libpgmodeler/src/pgsqltypes.h +++ b/libpgmodeler/src/pgsqltypes.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Description: Class definitions for the basic object/actions types on PostgreSQL -# Creation date: 31/08/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\brief Class definitions for the basic object/actions types on PostgreSQL +\note Creation date: 31/08/2006 +*/ + #ifndef PGSQL_TYPES_H #define PGSQL_TYPES_H diff --git a/libpgmodeler/src/reference.h b/libpgmodeler/src/reference.h index 770091123..1716bcfd4 100644 --- a/libpgmodeler/src/reference.h +++ b/libpgmodeler/src/reference.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Reference -# Description: This auxiliary class is used to define SQL/XML for views -# Creation date: 05/09/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Reference +\brief This auxiliary class is used to define SQL/XML for views +\note Creation date: 05/09/2008 +*/ + #ifndef REFERENCE_H #define REFERENCE_H diff --git a/libpgmodeler/src/relationship.h b/libpgmodeler/src/relationship.h index 78966bc88..0aa92b280 100644 --- a/libpgmodeler/src/relationship.h +++ b/libpgmodeler/src/relationship.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Relationship -# Description: This class implements the operations to create relationship between tables -# also generates the SQL code definition to represente the table link on PostgreSQL. -# Creation date: 20/11/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -20,6 +15,15 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class Relationship +\brief This class implements the operations to create relationship between tables +also generates the SQL code definition to represente the table link on PostgreSQL. +\note Creation date: 20/11/2006 +*/ + #ifndef RELATIONSHIP_H #define RELATIONSHIP_H diff --git a/libpgmodeler/src/role.h b/libpgmodeler/src/role.h index 49eb9efbe..df7032913 100644 --- a/libpgmodeler/src/role.h +++ b/libpgmodeler/src/role.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Role -# Description: Implements the operations to manipulate roles on the database. -# Creation date: 12/05/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Role +\brief Implements the operations to manipulate roles on the database. +\note Creation date: 12/05/2008 +*/ + #ifndef ROLE_H #define ROLE_H diff --git a/libpgmodeler/src/rule.h b/libpgmodeler/src/rule.h index 7acade183..7386a7a35 100644 --- a/libpgmodeler/src/rule.h +++ b/libpgmodeler/src/rule.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Rule -# Description: Implements the operations to manipulate table rules. -# Creation date: 26/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Rule +\brief Implements the operations to manipulate table rules. +\note Creation date: 26/09/2006 +*/ + #ifndef RULE_H #define RULE_H diff --git a/libpgmodeler/src/schema.h b/libpgmodeler/src/schema.h index c79fc4ccb..974fc0816 100644 --- a/libpgmodeler/src/schema.h +++ b/libpgmodeler/src/schema.h @@ -1,9 +1,5 @@ -/** @details +/* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Schema -# Description: Implements the operations to manipulate schemas on the database. -# Creation date: 07/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Schema +\brief Implements the operations to manipulate schemas on the database. +\note Creation date: 07/04/2008 +*/ + #ifndef SCHEMA_H #define SCHEMA_H diff --git a/libpgmodeler/src/sequence.h b/libpgmodeler/src/sequence.h index 6f88f3017..e5778aa81 100644 --- a/libpgmodeler/src/sequence.h +++ b/libpgmodeler/src/sequence.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Sequence -# Description: Implements the operations to manipulate sequences on the database. -# Creation date: 26/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Sequence +\brief Implements the operations to manipulate sequences on the database. +\note Creation date: 26/04/2008 +*/ + #ifndef SEQUENCE_H #define SEQUENCE_H diff --git a/libpgmodeler/src/table.h b/libpgmodeler/src/table.h index 294bcc8c9..c01ef271d 100644 --- a/libpgmodeler/src/table.h +++ b/libpgmodeler/src/table.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Description: Implements the operations to manipulate tables on the database. -# Creation date: 17/09/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\brief Implements the operations to manipulate tables on the database. +\note Creation date: 17/09/2006 +*/ + #ifndef TABLE_H #define TABLE_H diff --git a/libpgmodeler/src/tableobject.h b/libpgmodeler/src/tableobject.h index 2317dcdf7..da1d704fa 100644 --- a/libpgmodeler/src/tableobject.h +++ b/libpgmodeler/src/tableobject.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: TableObject -# Descritpoin: This class serves as a base class for objects that are embedded on tables -# like columns, rules, triggers, indexes, constraints. -# Creation date: 24/07/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -20,6 +15,15 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class TableObject +\brief This class serves as a base class for objects that are embedded on tables +like columns, rules, triggers, indexes, constraints. +\note Creation date: 24/07/2008 +*/ + #ifndef TABLE_OBJECT_H #define TABLE_OBJECT_H diff --git a/libpgmodeler/src/tablespace.h b/libpgmodeler/src/tablespace.h index 05ed11dd5..b278212b7 100644 --- a/libpgmodeler/src/tablespace.h +++ b/libpgmodeler/src/tablespace.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Tablespace -# Description: Implements the operations to manipulate tablespace on the database. -# -# Creation date: 05/06/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Tablespace +\brief Implements the operations to manipulate tablespace on the database. +\note Creation date: 05/06/2008 +*/ + #ifndef TABLESPACE_H #define TABLESPACE_H diff --git a/libpgmodeler/src/textbox.h b/libpgmodeler/src/textbox.h index a6fbada75..2cd74bdfd 100644 --- a/libpgmodeler/src/textbox.h +++ b/libpgmodeler/src/textbox.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Textbox -# Description: This class is used to represent informative textboxes over the -# model also used to represent relationship labels. -# Creation date: 05/09/2007 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -20,6 +15,15 @@ # 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 */ + +/** +\ingroup libpgmodeler +\class Textbox +\brief This class is used to represent informative textboxes over the +model also used to represent relationship labels. +\note Creation date: 05/09/2007 +*/ + #ifndef TEXTBOX_H #define TEXTBOX_H diff --git a/libpgmodeler/src/trigger.h b/libpgmodeler/src/trigger.h index 37da8da49..9a5abe380 100644 --- a/libpgmodeler/src/trigger.h +++ b/libpgmodeler/src/trigger.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Trigger -# Description: Implements the operations to manipulate triggers on the database. -# Creation date: 11/10/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Trigger +\brief Implements the operations to manipulate triggers on the database. +\note Creation date: 11/10/2006 +*/ + #ifndef TRIGGER_H #define TRIGGER_H diff --git a/libpgmodeler/src/type.h b/libpgmodeler/src/type.h index 786b4e0c2..0d7dace39 100644 --- a/libpgmodeler/src/type.h +++ b/libpgmodeler/src/type.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Class: Type -# Description: Implements the operations to manipulate user defined types on database. -# Creation date: 05/06/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\class Type +\brief Implements the operations to manipulate user defined types on database. +\note Creation date: 05/06/2008 +*/ + #ifndef TYPE_H #define TYPE_H diff --git a/libpgmodeler/src/view.h b/libpgmodeler/src/view.h index 9c754d342..ccbb80584 100644 --- a/libpgmodeler/src/view.h +++ b/libpgmodeler/src/view.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: Core library (libpgmodeler) -# Description: Implements the operations to manipulate views on database. -# Creation date: 07/04/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler +\brief Implements the operations to manipulate views on database. +\note Creation date: 07/04/2008 +*/ + #ifndef VIEW_H #define VIEW_H diff --git a/libpgmodeler_ui/src/appearanceconfigwidget.h b/libpgmodeler_ui/src/appearanceconfigwidget.h index ed865213e..f76a1a63c 100644 --- a/libpgmodeler_ui/src/appearanceconfigwidget.h +++ b/libpgmodeler_ui/src/appearanceconfigwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: AppearanceConfigWidget -# Description: Implements the operations to manage graphical objects appearance configuration. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class AppearanceConfigWidget +\brief Implements the operations to manage graphical objects appearance configuration. +*/ + #ifndef APPEARANCE_CONFIG_WIDGET_H #define APPEARANCE_CONFIG_WIDGET_H diff --git a/libpgmodeler_ui/src/baseconfigwidget.h b/libpgmodeler_ui/src/baseconfigwidget.h index 03b1b18da..7031cdb1f 100644 --- a/libpgmodeler_ui/src/baseconfigwidget.h +++ b/libpgmodeler_ui/src/baseconfigwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: BaseConfigWidget -# Description: Implements base operations to load/save XML based configuration files. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class BaseConfigWidget +\brief Implements base operations to load/save XML based configuration files. +*/ + #ifndef BASE_CONF_WIDGET_H #define BASE_CONF_WIDGET_H diff --git a/libpgmodeler_ui/src/baseobjectwidget.h b/libpgmodeler_ui/src/baseobjectwidget.h index c1490986f..89351229c 100644 --- a/libpgmodeler_ui/src/baseobjectwidget.h +++ b/libpgmodeler_ui/src/baseobjectwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: BaseObjectWidget -# Description: Implements the basic operations to create/edit database objects via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class BaseObjectWidget +\brief Implements the basic operations to create/edit database objects via form. +*/ + #ifndef BASE_OBJECT_WIDGET_H #define BASE_OBJECT_WIDGET_H diff --git a/libpgmodeler_ui/src/castwidget.h b/libpgmodeler_ui/src/castwidget.h index fbae4e5c0..51914319b 100644 --- a/libpgmodeler_ui/src/castwidget.h +++ b/libpgmodeler_ui/src/castwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: CastWidget -# Description: Implements the operations to create/edit type casts via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class CastWidget +\brief Implements the operations to create/edit type casts via form. +*/ + #ifndef CONVERSAOTIPO_WIDGET_H #define CONVERSAOTIPO_WIDGET_H diff --git a/libpgmodeler_ui/src/columnwidget.h b/libpgmodeler_ui/src/columnwidget.h index ba9a2faf8..0a611815b 100644 --- a/libpgmodeler_ui/src/columnwidget.h +++ b/libpgmodeler_ui/src/columnwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: ColumnWidget -# Description: Implements the operations to create/edit columns via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class ColumnWidget +\brief Implements the operations to create/edit columns via form. +*/ + #ifndef COLUMN_WIDGET_H #define COLUMN_WIDGET_H diff --git a/libpgmodeler_ui/src/connectionsconfigwidget.h b/libpgmodeler_ui/src/connectionsconfigwidget.h index 4c18431cc..4a4fadb1f 100644 --- a/libpgmodeler_ui/src/connectionsconfigwidget.h +++ b/libpgmodeler_ui/src/connectionsconfigwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: ConnectionsConfigWidget -# Description: Implements the operations to manage database connections. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class ConnectionsConfigWidget +\brief Implements the operations to manage database connections. +*/ + #ifndef CONNECTIONS_CONFIG_WIDGET_H #define CONNECTIONS_CONFIG_WIDGET_H diff --git a/libpgmodeler_ui/src/conversionwidget.h b/libpgmodeler_ui/src/conversionwidget.h index 606f2cd0c..7fa04f996 100644 --- a/libpgmodeler_ui/src/conversionwidget.h +++ b/libpgmodeler_ui/src/conversionwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: ConversionWidget -# Description: Implements the operations to create/edit encoding conversions via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class ConversionWidget +\brief Implements the operations to create/edit encoding conversions via form. +*/ + #ifndef CONVERSION_WIDGET_H #define CONVERSION_WIDGET_H diff --git a/libpgmodeler_ui/src/databasewidget.h b/libpgmodeler_ui/src/databasewidget.h index 00871e7c6..e14de24ee 100644 --- a/libpgmodeler_ui/src/databasewidget.h +++ b/libpgmodeler_ui/src/databasewidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: DatabaseWidget -# Description: Implements the operations to create/edit database attributes via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class DatabaseWidget +\brief Implements the operations to create/edit database attributes via form. +*/ + #ifndef DATABASE_WIDGET_H #define DATABASE_WIDGET_H diff --git a/libpgmodeler_ui/src/dominiowidget.h b/libpgmodeler_ui/src/dominiowidget.h index 0df6da28d..4638405f3 100644 --- a/libpgmodeler_ui/src/dominiowidget.h +++ b/libpgmodeler_ui/src/dominiowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: DominioWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de esquemas. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class DominioWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de esquemas. +*/ + #ifndef DOMINIO_WIDGET_H #define DOMINIO_WIDGET_H diff --git a/libpgmodeler_ui/src/espacotabelawidget.h b/libpgmodeler_ui/src/espacotabelawidget.h index 807bcf7f7..8891f3b0d 100644 --- a/libpgmodeler_ui/src/espacotabelawidget.h +++ b/libpgmodeler_ui/src/espacotabelawidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: EspacoTabelaWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de espaços de tabela. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class EspacoTabelaWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de espaços de tabela. +*/ + #ifndef ESPACOTABELA_WIDGET_H #define ESPACOTABELA_WIDGET_H diff --git a/libpgmodeler_ui/src/esquemawidget.h b/libpgmodeler_ui/src/esquemawidget.h index e5f5bb0a3..89d671979 100644 --- a/libpgmodeler_ui/src/esquemawidget.h +++ b/libpgmodeler_ui/src/esquemawidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: EsquemaWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de esquemas. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class EsquemaWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de esquemas. +*/ + #ifndef ESQUEMA_WIDGET_H #define ESQUEMA_WIDGET_H diff --git a/libpgmodeler_ui/src/familiaoperadoreswidget.h b/libpgmodeler_ui/src/familiaoperadoreswidget.h index ec2691a59..d94d9465a 100644 --- a/libpgmodeler_ui/src/familiaoperadoreswidget.h +++ b/libpgmodeler_ui/src/familiaoperadoreswidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FamiliaOperadoresWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de família de operadores. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FamiliaOperadoresWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de família de operadores. +*/ + #ifndef FAMILIAOPERADORES_WIDGET_H #define FAMILIAOPERADORES_WIDGET_H diff --git a/libpgmodeler_ui/src/formbasico.h b/libpgmodeler_ui/src/formbasico.h index c4157d586..dd50da5ba 100644 --- a/libpgmodeler_ui/src/formbasico.h +++ b/libpgmodeler_ui/src/formbasico.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FormBasico -# Description:Definição da classe que um container de widgets de configuração -# de objetos no modelo de banco de dados. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FormBasico +\brief Definição da classe que um container de widgets de configuração de objetos no modelo de banco de dados. +*/ + #ifndef FROM_BASICO_H #define FROM_BASICO_H diff --git a/libpgmodeler_ui/src/formconfiguracao.h b/libpgmodeler_ui/src/formconfiguracao.h index e428e381a..0f17a97a6 100644 --- a/libpgmodeler_ui/src/formconfiguracao.h +++ b/libpgmodeler_ui/src/formconfiguracao.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FormConfiguracao -# Description:Formulario que reúne todos os widgets de configuração. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FormConfiguracao +\brief Formulario que reúne todos os widgets de configuração. +*/ + #ifndef FORM_CONFIGURACAO_H #define FORM_CONFIGURACAO_H diff --git a/libpgmodeler_ui/src/formexportacao.h b/libpgmodeler_ui/src/formexportacao.h index 2ada38ca6..558024d89 100644 --- a/libpgmodeler_ui/src/formexportacao.h +++ b/libpgmodeler_ui/src/formexportacao.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FormExportacao -# Description:Formulário de exportação do modelo # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FormExportacao +\brief Formulário de exportação do modelo +*/ + #ifndef FORM_EXPORTACAO_H #define FORM_EXPORTACAO_H diff --git a/libpgmodeler_ui/src/formprincipal.h b/libpgmodeler_ui/src/formprincipal.h index e8087bc79..d8a10cde0 100644 --- a/libpgmodeler_ui/src/formprincipal.h +++ b/libpgmodeler_ui/src/formprincipal.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FormPrincipal -# Description:Definição da classe que implementa o formulário principal do software, -# Reune e gerencia todas as classes das bibliotecas implementadas. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FormPrincipal +\brief Definição da classe que implementa o formulário principal do software, + Reune e gerencia todas as classes das bibliotecas implementadas. +*/ + #ifndef FORM_PRINCIPAL_H #define FORM_PRINCIPAL_H diff --git a/libpgmodeler_ui/src/formrestauracaomodelo.h b/libpgmodeler_ui/src/formrestauracaomodelo.h index c654a804c..6c5109161 100644 --- a/libpgmodeler_ui/src/formrestauracaomodelo.h +++ b/libpgmodeler_ui/src/formrestauracaomodelo.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FormRestrauracaoModelos -# Description:Formulário de restauração de modelos temporários # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FormRestrauracaoModelos +\brief Formulário de restauração de modelos temporários +*/ + #ifndef FORM_RESTAURACAO_MODELOS_H #define FORM_RESTAURACAO_MODELOS_H diff --git a/libpgmodeler_ui/src/formsobre.h b/libpgmodeler_ui/src/formsobre.h index b28a2b1dd..4969ce7a3 100644 --- a/libpgmodeler_ui/src/formsobre.h +++ b/libpgmodeler_ui/src/formsobre.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FormPrincipal -# Description:Definição da classe que implementa a caixa de informações do software. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FormPrincipal +\brief Definição da classe que implementa a caixa de informações do software. +*/ + #ifndef FORM_SOBRE_H #define FORM_SOBRE_H diff --git a/libpgmodeler_ui/src/funcaoagregacaowidget.h b/libpgmodeler_ui/src/funcaoagregacaowidget.h index 4f340b4c1..4cd913882 100644 --- a/libpgmodeler_ui/src/funcaoagregacaowidget.h +++ b/libpgmodeler_ui/src/funcaoagregacaowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FuncaoAgregacaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de funções de agregação. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FuncaoAgregacaoWidget +\brief Definição da classe que implementa o formulário de + edição dos atributos de funções de agregação. +*/ + #ifndef FUNCAO_AGREGADA_WIDGET_H #define FUNCAO_AGREGADA_WIDGET_H diff --git a/libpgmodeler_ui/src/funcaowidget.h b/libpgmodeler_ui/src/funcaowidget.h index 93cc40dc3..b3001e053 100644 --- a/libpgmodeler_ui/src/funcaowidget.h +++ b/libpgmodeler_ui/src/funcaowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: FuncaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de funções. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class FuncaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de funções. +*/ + #ifndef FUNCAO_WIDGET_H #define FUNCAO_WIDGET_H diff --git a/libpgmodeler_ui/src/gatilhowidget.h b/libpgmodeler_ui/src/gatilhowidget.h index 72c403e1e..448ddc2cb 100644 --- a/libpgmodeler_ui/src/gatilhowidget.h +++ b/libpgmodeler_ui/src/gatilhowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: GatilhoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de gatilhos / gatilhos restrições. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class GatilhoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de gatilhos / gatilhos restrições. +*/ + #ifndef GATILHO_WIDGET_H #define GATILHO_WIDGET_H diff --git a/libpgmodeler_ui/src/generalconfigwidget.h b/libpgmodeler_ui/src/generalconfigwidget.h index 54eb0254f..63172c0ab 100644 --- a/libpgmodeler_ui/src/generalconfigwidget.h +++ b/libpgmodeler_ui/src/generalconfigwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: GeneralConfigWidget -# Description: Implements the operations to manage general configurations. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -18,8 +15,15 @@ # 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 */ -#ifndef CONF_GERAL_WIDGET_H -#define CONF_GERAL_WIDGET_H + +/** +\ingroup libpgmodeler_ui +\class GeneralConfigWidget +\brief Implements the operations to manage general configurations. +*/ + +#ifndef GENERAL_CONFIG_WIDGET_H +#define GENERAL_CONFIG_WIDGET_H #include "ui_generalconfigwidget.h" #include "baseconfigwidget.h" diff --git a/libpgmodeler_ui/src/indicewidget.h b/libpgmodeler_ui/src/indicewidget.h index 2215cd4c7..7529c0ad0 100644 --- a/libpgmodeler_ui/src/indicewidget.h +++ b/libpgmodeler_ui/src/indicewidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: RestricaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de índices. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class RestricaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de índices. +*/ + #ifndef INDICE_WIDGET_H #define INDICE_WIDGET_H diff --git a/libpgmodeler_ui/src/linguagemwidget.h b/libpgmodeler_ui/src/linguagemwidget.h index 68d5633e4..0d130a41d 100644 --- a/libpgmodeler_ui/src/linguagemwidget.h +++ b/libpgmodeler_ui/src/linguagemwidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: LinguagemWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de linguagens. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class LinguagemWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de linguagens. +*/ + #ifndef LINGUAGEM_WIDGET_H #define LINGUAGEM_WIDGET_H diff --git a/libpgmodeler_ui/src/listaobjetoswidget.h b/libpgmodeler_ui/src/listaobjetoswidget.h index f0e378a69..391351fd9 100644 --- a/libpgmodeler_ui/src/listaobjetoswidget.h +++ b/libpgmodeler_ui/src/listaobjetoswidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: ListaObjetosWidget -# Description:Definição da classe que implementa o formulário de -# exibição das dependências e referências a um objeto # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class ListaObjetosWidget +\brief Definição da classe que implementa o formulário de exibição das dependências e referências a um objeto +*/ + #ifndef LISTA_OBJETOS_WIDGET_H #define LISTA_OBJETOS_WIDGET_H diff --git a/libpgmodeler_ui/src/listaoperacoeswidget.h b/libpgmodeler_ui/src/listaoperacoeswidget.h index 283e6698f..d8a04aa72 100644 --- a/libpgmodeler_ui/src/listaoperacoeswidget.h +++ b/libpgmodeler_ui/src/listaoperacoeswidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: ListaOperacoesWidget -# Description:Definição da classe que implementa a arvore de operações executadas -# no modelo de banco de dados. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class ListaOperacoesWidget +\brief Definição da classe que implementa a arvore de operações executadas no modelo de banco de dados. +*/ + #ifndef LISTA_OPERACOES_WIDGET_H #define LISTA_OPERACOES_WIDGET_H diff --git a/libpgmodeler_ui/src/messagebox.h b/libpgmodeler_ui/src/messagebox.h index 38b76526f..3b33856df 100644 --- a/libpgmodeler_ui/src/messagebox.h +++ b/libpgmodeler_ui/src/messagebox.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: MessageBox -# Description: Implements the message box to show errors / alerts / infos to the user. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class MessageBox +\brief Implements the message box to show errors / alerts / infos to the user. +*/ + #ifndef MESSAGEBOX_H #define MESSAGEBOX_H diff --git a/libpgmodeler_ui/src/modelowidget.h b/libpgmodeler_ui/src/modelowidget.h index 7af73b10f..f0bf5556a 100644 --- a/libpgmodeler_ui/src/modelowidget.h +++ b/libpgmodeler_ui/src/modelowidget.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: ModeloWidget -# Description:Definição da classe que implementa o modelo de banco de dados -# em sua forma de widget, ou seja, que permite a interação do usuário -# para criação de objetos gráficos e outras operações sobre os mesmos. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -20,6 +15,15 @@ # 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 */ + +/** +\ingroup libpgmodeler_ui +\class ModeloWidget +\brief Definição da classe que implementa o modelo de banco de dados + em sua forma de widget, ou seja, que permite a interação do usuário + para criação de objetos gráficos e outras operações sobre os mesmos. +*/ + #ifndef MODELO_WIDGET_H #define MODELO_WIDGET_H diff --git a/libpgmodeler_ui/src/operadorwidget.h b/libpgmodeler_ui/src/operadorwidget.h index 677f2bef8..2ca7e48f1 100644 --- a/libpgmodeler_ui/src/operadorwidget.h +++ b/libpgmodeler_ui/src/operadorwidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: OperadorWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de operadores. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class OperadorWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de operadores. +*/ + #ifndef OPERADOR_WIDGET_H #define OPERADOR_WIDGET_H diff --git a/libpgmodeler_ui/src/operatorclasswidget.h b/libpgmodeler_ui/src/operatorclasswidget.h index 6387387e7..101548a08 100644 --- a/libpgmodeler_ui/src/operatorclasswidget.h +++ b/libpgmodeler_ui/src/operatorclasswidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: OperatorClassWidget -# Description: Implements the operations to create/edit operator class via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class OperatorClassWidget +\brief Implements the operations to create/edit operator class via form. +*/ + #ifndef OPERATOR_CLASS_WIDGET_H #define OPERATOR_CLASS_WIDGET_H diff --git a/libpgmodeler_ui/src/papelwidget.h b/libpgmodeler_ui/src/papelwidget.h index 1104505c3..783a66a32 100644 --- a/libpgmodeler_ui/src/papelwidget.h +++ b/libpgmodeler_ui/src/papelwidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: PapelWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de esquemas. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class PapelWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de esquemas. +*/ + #ifndef PAPEL_WIDGET_H #define PAPEL_WIDGET_H diff --git a/libpgmodeler_ui/src/parametrowidget.h b/libpgmodeler_ui/src/parametrowidget.h index 9f5e6aa42..0ba6d1ca2 100644 --- a/libpgmodeler_ui/src/parametrowidget.h +++ b/libpgmodeler_ui/src/parametrowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: ParametroWidget -# Description:Definição da classe que implementa o formulário de -# edição de parâmetro de funções. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -19,10 +15,16 @@ # 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 */ + +/** +\ingroup libpgmodeler_ui +\class ParametroWidget +\brief Definição da classe que implementa o formulário de edição de parâmetro de funções. +*/ + #ifndef PARAMETRO_WIDGET_H #define PARAMETRO_WIDGET_H - #include "baseobjectwidget.h" #include "ui_parametrowidget.h" #include "tipopgsqlwidget.h" diff --git a/libpgmodeler_ui/src/permissaowidget.h b/libpgmodeler_ui/src/permissaowidget.h index 70a7547de..79457653f 100644 --- a/libpgmodeler_ui/src/permissaowidget.h +++ b/libpgmodeler_ui/src/permissaowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: PermissaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de permissões de objetos. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class PermissaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de permissões de objetos. +*/ + #ifndef PERMISSAO_WIDGET_H #define PERMISSAO_WIDGET_H diff --git a/libpgmodeler_ui/src/pgmodelerplugin.h b/libpgmodeler_ui/src/pgmodelerplugin.h index 783f5c3eb..77d888926 100644 --- a/libpgmodeler_ui/src/pgmodelerplugin.h +++ b/libpgmodeler_ui/src/pgmodelerplugin.h @@ -1,9 +1,5 @@ /* # Projeto: Modelador de Banco de Dados PostgreSQL (pgsqlDBM) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: PgModelerLibrary -# Description:Definição da classe que implementa a base para suporte de plugins de terceiros, -# baseados em bibliotecas compartilhadas. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -19,12 +15,19 @@ # 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 */ + +/** +\ingroup libpgmodeler_ui +\class PgModelerLibrary +\brief Definição da classe que implementa a base para suporte de plugins de terceiros, baseados em bibliotecas compartilhadas. +*/ + #ifndef PGMODELER_PLUGIN_H #define PGMODELER_PLUGIN_H #include "modelowidget.h" -/** @details Os plugins no pgModeler deve estar dentro da pasta "plugins" +/* Os plugins no pgModeler deve estar dentro da pasta "plugins" em um diretório próprio (recomenda-se usar o mesmo nome do plugin) e deve possuir a seguinte estrutura básica: diff --git a/libpgmodeler_ui/src/pluginsconfigwidget.h b/libpgmodeler_ui/src/pluginsconfigwidget.h index fd677b3f0..5bfb1248b 100644 --- a/libpgmodeler_ui/src/pluginsconfigwidget.h +++ b/libpgmodeler_ui/src/pluginsconfigwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: PluginsConfigWidget -# Description: Implements the operations to manage plugins. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class PluginsConfigWidget +\brief Implements the operations to manage plugins. +*/ + #ifndef PLUGINS_CONFIG_WIDGET_H #define PLUGINS_CONFIG_WIDGET_H diff --git a/libpgmodeler_ui/src/progressotarefa.h b/libpgmodeler_ui/src/progressotarefa.h index 4e8062746..2c5617f7d 100644 --- a/libpgmodeler_ui/src/progressotarefa.h +++ b/libpgmodeler_ui/src/progressotarefa.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: ProgressaoTarefa -# Description:Definição da classe que implementa um widget que sinaliza a progressão -# de execução de tarefas # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class ProgressaoTarefa +\brief Definição da classe que implementa um widget que sinaliza a progressão de execução de tarefas +*/ + #ifndef PROGRESSO_TAREFA_H #define PROGRESSO_TAREFA_H diff --git a/libpgmodeler_ui/src/quickrenamewidget.h b/libpgmodeler_ui/src/quickrenamewidget.h index c624d4b48..b17b72ec0 100644 --- a/libpgmodeler_ui/src/quickrenamewidget.h +++ b/libpgmodeler_ui/src/quickrenamewidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler User Interface Library (libpgmodeler_ui) -# Classe: QuickRenameWidget -# Description: Widget used to quickly rename objects without open the editing form # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\note Sub-project: pgModeler User Interface Library (libpgmodeler_ui) +\class QuickRenameWidget +\brief Widget used to quickly rename objects without open the editing form +*/ + #ifndef QUICK_RENAME_WIDGET_H #define QUICK_RENAME_WIDGET_H diff --git a/libpgmodeler_ui/src/regrawidget.h b/libpgmodeler_ui/src/regrawidget.h index 8437e9b9c..22cbe218a 100644 --- a/libpgmodeler_ui/src/regrawidget.h +++ b/libpgmodeler_ui/src/regrawidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: RegraWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de regras. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class RegraWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de regras. +*/ + #ifndef REGRA_WIDGET_H #define REGRA_WIDGET_H diff --git a/libpgmodeler_ui/src/relacionamentowidget.h b/libpgmodeler_ui/src/relacionamentowidget.h index d095941bc..47061730b 100644 --- a/libpgmodeler_ui/src/relacionamentowidget.h +++ b/libpgmodeler_ui/src/relacionamentowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: RestricaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de relacionamentos. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class RestricaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de relacionamentos. +*/ + #ifndef RELACIONAMENTO_WIDGET_H #define RELACIONAMENTO_WIDGET_H diff --git a/libpgmodeler_ui/src/restricaowidget.h b/libpgmodeler_ui/src/restricaowidget.h index f7d5ee4c4..786f6c414 100644 --- a/libpgmodeler_ui/src/restricaowidget.h +++ b/libpgmodeler_ui/src/restricaowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: RestricaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de restrições. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class RestricaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de restrições. +*/ + #ifndef RESTRICAO_WIDGET_H #define RESTRICAO_WIDGET_H diff --git a/libpgmodeler_ui/src/seletorobjetowidget.h b/libpgmodeler_ui/src/seletorobjetowidget.h index 660cee389..abd8a57cb 100644 --- a/libpgmodeler_ui/src/seletorobjetowidget.h +++ b/libpgmodeler_ui/src/seletorobjetowidget.h @@ -1,12 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: SeletorObjetoWidget -# Description:Definição da classe que implementa um seletor de objetos simples -# o qual integra o formulário de visão de objetos onde o usuário -# pode selecionar o objeto a ser exibido e alguns botões de controle -# do próprio seletor, usados para limpar o campo e para abrir a janela -# de seleção. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -22,6 +15,16 @@ # 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 */ + +/** +\ingroup libpgmodeler_ui +\class SeletorObjetoWidget +\brief Definição da classe que implementa um seletor de objetos simples + o qual integra o formulário de visão de objetos onde o usuário + pode selecionar o objeto a ser exibido e alguns botões de controle + do próprio seletor, usados para limpar o campo e para abrir a janela de seleção. +*/ + #ifndef SELETOR_OBJETO_WIDGET_H #define SELETOR_OBJETO_WIDGET_H diff --git a/libpgmodeler_ui/src/sequenciawidget.h b/libpgmodeler_ui/src/sequenciawidget.h index bb331945c..d1ce7123c 100644 --- a/libpgmodeler_ui/src/sequenciawidget.h +++ b/libpgmodeler_ui/src/sequenciawidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: SequenciaWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de sequências. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class SequenciaWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de sequências. +*/ + #ifndef SEQUENCIA_WIDGET_H #define SEQUENCIA_WIDGET_H diff --git a/libpgmodeler_ui/src/sourcecodewidget.h b/libpgmodeler_ui/src/sourcecodewidget.h index a7888806b..90b4fbc7b 100644 --- a/libpgmodeler_ui/src/sourcecodewidget.h +++ b/libpgmodeler_ui/src/sourcecodewidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: SourceCodeWidget -# Description: Implements the operation to visualize object's source code. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class SourceCodeWidget +\brief Implements the operation to visualize object's source code. +*/ + #ifndef CODIGOFONTE_WIDGET_H #define CODIGOFONTE_WIDGET_H diff --git a/libpgmodeler_ui/src/syntaxhighlighter.h b/libpgmodeler_ui/src/syntaxhighlighter.h index 544291ec7..14aafa7c2 100644 --- a/libpgmodeler_ui/src/syntaxhighlighter.h +++ b/libpgmodeler_ui/src/syntaxhighlighter.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: DestaqueSintaxe -# Description:Definição da classe que implementa um destacador de sintaxe de -# linguagens (código fonte) com padrões de marcação definidos pelo usuário. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class DestaqueSintaxe +\brief Definição da classe que implementa um destacador de sintaxe de + linguagens (código fonte) com padrões de marcação definidos pelo usuário. +*/ + #ifndef DESTAQUE_SINTAXE_H #define DESTAQUE_SINTAXE_H diff --git a/libpgmodeler_ui/src/tabelaobjetoswidget.h b/libpgmodeler_ui/src/tabelaobjetoswidget.h index c0c6c80ba..f826f9fcb 100644 --- a/libpgmodeler_ui/src/tabelaobjetoswidget.h +++ b/libpgmodeler_ui/src/tabelaobjetoswidget.h @@ -1,12 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: TabelaObjetosWidget -# Description:Definição da classe que implementa uma tabela para manipulação -# vários objetos em uma grade. Incluíndo funções de inclusão e exclusão -# de objeto e movimentação dos mesmos nas linhas da tabela. Esta classe -# é usada como auxiliar em formulários os quais trabalham com vários objetos -# filhos de um objeto pai único (ex.: Tabelas, Indices, Restrições). # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -22,6 +15,17 @@ # 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 */ + +/** +\ingroup libpgmodeler_ui +\class TabelaObjetosWidget +\brief Definição da classe que implementa uma tabela para manipulação + vários objetos em uma grade. Incluíndo funções de inclusão e exclusão + de objeto e movimentação dos mesmos nas linhas da tabela. Esta classe + é usada como auxiliar em formulários os quais trabalham com vários objetos + filhos de um objeto pai único (ex.: Tabelas, Indices, Restrições). +*/ + #ifndef TABELA_OBJETOS_WIDGET_H #define TABELA_OBJETOS_WIDGET_H diff --git a/libpgmodeler_ui/src/tabelawidget.h b/libpgmodeler_ui/src/tabelawidget.h index b1b725097..5504c2a92 100644 --- a/libpgmodeler_ui/src/tabelawidget.h +++ b/libpgmodeler_ui/src/tabelawidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: RestricaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de tabela. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class RestricaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de tabela. +*/ + #ifndef TABELA_WIDGET_H #define TABELA_WIDGET_H diff --git a/libpgmodeler_ui/src/textboxwidget.h b/libpgmodeler_ui/src/textboxwidget.h index 3cacad98b..2dfa51004 100644 --- a/libpgmodeler_ui/src/textboxwidget.h +++ b/libpgmodeler_ui/src/textboxwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Class: TextboxWidget -# Description: Implements the operations to create/edit textboxes via form. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class TextboxWidget +\brief Implements the operations to create/edit textboxes via form. +*/ + #ifndef TEXTBOX_WIDGET_H #define TEXTBOX_WIDGET_H diff --git a/libpgmodeler_ui/src/tipopgsqlwidget.h b/libpgmodeler_ui/src/tipopgsqlwidget.h index bb2bb4681..560128a24 100644 --- a/libpgmodeler_ui/src/tipopgsqlwidget.h +++ b/libpgmodeler_ui/src/tipopgsqlwidget.h @@ -1,12 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: TipoPgSQLWidget -# Description:Definição da classe que implementa o formulário de -# edição de tipos nativos do PostgreSQL. Este formulário -# é compartilhado por vários outros por isso a necessidade -# de se criar esta classe com esse fim específico evitando -# a redundância de código e de objetos gráficos. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -22,6 +15,17 @@ # 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 */ + +/** +\ingroup libpgmodeler_ui +\class TipoPgSQLWidget +\brief Definição da classe que implementa o formulário de + edição de tipos nativos do PostgreSQL. Este formulário + é compartilhado por vários outros por isso a necessidade + de se criar esta classe com esse fim específico evitando + a redundância de código e de objetos gráficos. +*/ + #ifndef TIPOPGSQL_WIDGET_H #define TIPOPGSQL_WIDGET_H diff --git a/libpgmodeler_ui/src/tipowidget.h b/libpgmodeler_ui/src/tipowidget.h index b930a3838..39b3dcb58 100644 --- a/libpgmodeler_ui/src/tipowidget.h +++ b/libpgmodeler_ui/src/tipowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: TipoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de tipos definidos pelo usuário. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class TipoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de tipos definidos pelo usuário. +*/ + #ifndef TIPO_WIDGET_H #define TIPO_WIDGET_H diff --git a/libpgmodeler_ui/src/visaogeralwidget.h b/libpgmodeler_ui/src/visaogeralwidget.h index fb99053c1..6907f7373 100644 --- a/libpgmodeler_ui/src/visaogeralwidget.h +++ b/libpgmodeler_ui/src/visaogeralwidget.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: VisaoGeralWidget -# Description:Definição da classe que implementa o widget de visão geral do modelo. # # Copyright (C) 2006-2012 - Raphael Araujo e Silva # @@ -20,6 +17,13 @@ # along with this program; if not, write to the Free Software Foundation, # Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ + +/** +\ingroup libpgmodeler_ui +\class VisaoGeralWidget +\brief Definição da classe que implementa o widget de visão geral do modelo. +*/ + #ifndef VISAO_GERAL_WIDGET_H #define VISAO_GERAL_WIDGET_H diff --git a/libpgmodeler_ui/src/visaoobjetoswidget.h b/libpgmodeler_ui/src/visaoobjetoswidget.h index 5171c47b8..c5cf1f5bc 100644 --- a/libpgmodeler_ui/src/visaoobjetoswidget.h +++ b/libpgmodeler_ui/src/visaoobjetoswidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: VisaoObjetosWidget -# Description:Definição da classe que implementa a arvore e lista de objetos -# no modelo de banco de dados. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class VisaoObjetosWidget +\brief Definição da classe que implementa a arvore e lista de objetos no modelo de banco de dados. +*/ + #ifndef VISAO_OBJETOS_WIDGET_H #define VISAO_OBJETOS_WIDGET_H diff --git a/libpgmodeler_ui/src/visaowidget.h b/libpgmodeler_ui/src/visaowidget.h index 0aa120be3..a56b5ad7d 100644 --- a/libpgmodeler_ui/src/visaowidget.h +++ b/libpgmodeler_ui/src/visaowidget.h @@ -1,9 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: pgModeler UI library (libpgmodeler_ui) -# Classe: VisaoWidget -# Description:Definição da classe que implementa o formulário de -# edição dos atributos de visões. # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup libpgmodeler_ui +\class VisaoWidget +\brief Definição da classe que implementa o formulário de edição dos atributos de visões. +*/ + #ifndef VISAO_WIDGET_H #define VISAO_WIDGET_H diff --git a/libutil/src/exception.h b/libutil/src/exception.h index d23739dda..7185a3ce4 100644 --- a/libutil/src/exception.h +++ b/libutil/src/exception.h @@ -1,8 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: libutil library -# Classe: Exception -# Creation date: 10/07/2006 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -18,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 */ + +/** +\ingroup libutil +\class Exception +\brief Catalogs all the errors raised by pgModeler +\note Creation date: 10/07/2006 +*/ + #ifndef EXCEPTION_H #define EXCEPTION_H diff --git a/libutil/src/globalattributes.h b/libutil/src/globalattributes.h index 172e33a06..994367242 100644 --- a/libutil/src/globalattributes.h +++ b/libutil/src/globalattributes.h @@ -1,11 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: libutil library -# Description: Definition of GlobalAttributes namespace wich -# stores a series of static strings constants used -# to reference the global configuration attributes of -# the software. -# Creation date: 14/05/2010 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -21,6 +15,15 @@ # 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 */ + +/** +\ingroup libutil +\namespace GlobalAttributes +\brief Definition of GlobalAttributes namespace wich stores a series of static strings constants used + to reference the global configuration attributes of the software. +\note Creation date: 14/05/2010 +*/ + #ifndef GLOBAL_ATTRIBUTES_H #define GLOBAL_ATTRIBUTES_H diff --git a/libutil/src/parsersattributes.h b/libutil/src/parsersattributes.h index 8962d6474..726a924ee 100644 --- a/libutil/src/parsersattributes.h +++ b/libutil/src/parsersattributes.h @@ -1,13 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: libutil library -# Description: Definition of parsers attributes namespace which -# stores a series of static strings constants used -# to reference the attributes of objects in SQL/XML -# generation methods. -# Each string stores the name of the attribute used -# in the schema file "sch" of the respective objects. -# Creation date: 23/09/2008 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -23,6 +15,16 @@ # 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 */ + +/** +\ingroup libutil +\namespace ParsersAttributes +\brief Definition of parsers attributes namespace which stores a series of static strings constants used + to reference the attributes of objects in SQL/XML generation methods. + Each string stores the name of the attribute used in the schema file "sch" of the respective objects. +\note Creation date: 23/09/2008 +*/ + #ifndef PARSERS_ATTRIBUTES_H #define PARSERS_ATTRIBUTES_H diff --git a/main/src/application.h b/main/src/application.h index 87343b342..1cd0eac49 100644 --- a/main/src/application.h +++ b/main/src/application.h @@ -1,10 +1,5 @@ /* # PostgreSQL Database Modeler (pgModeler) -# Sub-project: main -# Classe: Application -# Description: This class inherits from QApplication and has the notify() method modified -# to treat the exceptions raised by pgModeler components. -# Creation date: 30/08/2007 # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -20,6 +15,15 @@ # 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 */ + +/** +\ingroup main +\class Application +\brief This class inherits from QApplication and has the notify() method modified + to treat the exceptions raised by pgModeler components. +\note Creation date: 30/08/2007 +*/ + #ifndef APPLICATION_H #define APPLICATION_H diff --git a/plugins/dummyplugin/src/dummyplugin.h b/plugins/dummyplugin/src/dummyplugin.h index 56d7e1f77..3dcb842d3 100644 --- a/plugins/dummyplugin/src/dummyplugin.h +++ b/plugins/dummyplugin/src/dummyplugin.h @@ -1,8 +1,5 @@ /* # Projeto: Modelador de Banco de Dados PostgreSQL (pgModeler) -# Sub-projeto: Biblioteca libobjrenderer -# Classe: DummyPlugin -# Descrição: Example plugin for pgModeler (does not execute any operation) # # Copyright 2006-2013 - Raphael Araújo e Silva # @@ -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 */ + +/** +\ingroup dummyplugin +\class DummyPlugin +\brief Example plugin for pgModeler (does not execute any complex operation) +*/ + #ifndef DUMMY_PLUGIN_H #define DUMMY_PLUGIN_H