Added some class descriptions and Doxygen config.

This commit is contained in:
Eelke Klein 2017-02-01 20:00:03 +01:00
parent 343390ff38
commit 43c3835350
4 changed files with 2464 additions and 0 deletions

2454
Doxyfile Normal file

File diff suppressed because it is too large Load diff

View file

@ -11,6 +11,10 @@
#include "expected.h" #include "expected.h"
/** \brief Model class for the list of connections.
*
* This class also allows for the editing of the list.
*/
class ConnectionListModel : public QAbstractListModel { class ConnectionListModel : public QAbstractListModel {
Q_OBJECT Q_OBJECT
public: public:

View file

@ -21,6 +21,9 @@ typedef std::shared_ptr<ExplainTreeModelItem> ExplainTreeModelItemPtr;
* 4. rows * 4. rows
* 5. loops * 5. loops
*/ */
/** \brief Model class for displaying the explain of a query in a tree like format.
*/
class ExplainTreeModelItem: public std::enable_shared_from_this<ExplainTreeModelItem> { class ExplainTreeModelItem: public std::enable_shared_from_this<ExplainTreeModelItem> {
public: public:
typedef std::shared_ptr<ExplainTreeModelItem> ItemPtr; typedef std::shared_ptr<ExplainTreeModelItem> ItemPtr;

View file

@ -7,6 +7,9 @@
class PgsqlDatabaseCatalogue; class PgsqlDatabaseCatalogue;
/** Instances of this class represent a single database on which atleast one
* window is opened. This class is used to track details about that database.
*/
class OpenDatabase : public QObject class OpenDatabase : public QObject
{ {
Q_OBJECT Q_OBJECT