added doxygen
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
/*!
|
||||
\file cobject.h
|
||||
|
||||
*/
|
||||
|
||||
#ifndef COBJECT_H
|
||||
#define COBJECT_H
|
||||
|
||||
@@ -11,33 +16,105 @@
|
||||
#include <QObject>
|
||||
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\class cObject cobject.h "cobject.h"
|
||||
*/
|
||||
class cObject : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
public:
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn cObject
|
||||
\param iID
|
||||
\param parent
|
||||
*/
|
||||
explicit cObject(qint32 iID = -1, QObject *parent = nullptr);
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn setID
|
||||
\param iID
|
||||
*/
|
||||
void setID(const qint32& iID);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn id
|
||||
\return qint32
|
||||
*/
|
||||
qint32 id();
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn setName
|
||||
\param szName
|
||||
*/
|
||||
void setName(const QString& szName);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn name
|
||||
\return QString
|
||||
*/
|
||||
QString name();
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn setType
|
||||
\param szType
|
||||
*/
|
||||
void setType(const QString& szType);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn type
|
||||
\return QString
|
||||
*/
|
||||
QString type();
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn setDescription
|
||||
\param lpDescription
|
||||
*/
|
||||
void setDescription(cTextDocument* lpDescription);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn description
|
||||
\return cTextDocument
|
||||
*/
|
||||
cTextDocument* description();
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn addImage
|
||||
\param lpImage
|
||||
*/
|
||||
void addImage(cImage* lpImage);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn images
|
||||
\return QList<cImage *>
|
||||
*/
|
||||
QList<cImage*> images();
|
||||
|
||||
private:
|
||||
qint32 m_iID;
|
||||
QString m_szName;
|
||||
QString m_szType;
|
||||
cTextDocument* m_lpDescription;
|
||||
QList<cImage*> m_imageList;
|
||||
qint32 m_iID; /*!< TODO: describe */
|
||||
QString m_szName; /*!< TODO: describe */
|
||||
QString m_szType; /*!< TODO: describe */
|
||||
cTextDocument* m_lpDescription; /*!< TODO: describe */
|
||||
QList<cImage*> m_imageList; /*!< TODO: describe */
|
||||
|
||||
signals:
|
||||
|
||||
@@ -46,13 +123,45 @@ public slots:
|
||||
|
||||
Q_DECLARE_METATYPE(cObject*)
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\class cObjectList cobject.h "cobject.h"
|
||||
*/
|
||||
class cObjectList : public QList<cObject*>
|
||||
{
|
||||
public:
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn load
|
||||
\param lpImageList
|
||||
\return bool
|
||||
*/
|
||||
bool load(cImageList* lpImageList);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn save
|
||||
\return bool
|
||||
*/
|
||||
bool save();
|
||||
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn add
|
||||
\param iID
|
||||
\return cObject
|
||||
*/
|
||||
cObject* add(const qint32& iID);
|
||||
/*!
|
||||
\brief
|
||||
|
||||
\fn find
|
||||
\param iID
|
||||
\return cObject
|
||||
*/
|
||||
cObject* find(const qint32& iID);
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user