Added some documentation.

This commit is contained in:
Klaas Freitag 2015-11-16 15:38:08 +01:00
parent a56926b8d9
commit ff76a842d0
3 changed files with 28 additions and 3 deletions

View file

@ -50,7 +50,7 @@ QString ActivityList::accountName() const
return _accountName; return _accountName;
} }
// ======================================================================== /* ==================================================================== */
ActivityListModel::ActivityListModel(QWidget *parent) ActivityListModel::ActivityListModel(QWidget *parent)
:QAbstractListModel(parent) :QAbstractListModel(parent)
@ -374,6 +374,7 @@ void ActivityWidget::slotOpenFile(QModelIndex indx)
} }
} }
/* ==================================================================== */
ActivitySettings::ActivitySettings(QWidget *parent) ActivitySettings::ActivitySettings(QWidget *parent)
:QWidget(parent) :QWidget(parent)

View file

@ -40,8 +40,10 @@ namespace Ui {
class Application; class Application;
/** /**
* @brief The ActivityListModel * @brief Activity Structure
* @ingroup gui * @ingroup gui
*
* contains all the information describing a single activity.
*/ */
class Activity class Activity
@ -66,6 +68,12 @@ public:
}; };
/**
* @brief The ActivityList
* @ingroup gui
*
* A QList based list of Activities
*/
class ActivityList:public QList<Activity> class ActivityList:public QList<Activity>
{ {
// explicit ActivityList(); // explicit ActivityList();
@ -78,7 +86,12 @@ private:
}; };
/**
* @brief The ActivityListModel
* @ingroup gui
*
* Simple list model to provide the list view with data.
*/
class ActivityListModel : public QAbstractListModel class ActivityListModel : public QAbstractListModel
{ {
Q_OBJECT Q_OBJECT
@ -113,6 +126,9 @@ private:
/** /**
* @brief The ActivityWidget class * @brief The ActivityWidget class
* @ingroup gui * @ingroup gui
*
* The list widget to display the activities, contained in the
* subsequent ActivitySettings widget.
*/ */
class ActivityWidget : public QWidget class ActivityWidget : public QWidget
@ -143,6 +159,13 @@ private:
}; };
/**
* @brief The ActivitySettings class
* @ingroup gui
*
* Implements a tab for the settings dialog, displaying the three activity
* lists.
*/
class ActivitySettings : public QWidget class ActivitySettings : public QWidget
{ {
Q_OBJECT Q_OBJECT

View file

@ -837,6 +837,7 @@ QStringList FolderMan::findFileInLocalFolders( const QString& relPath )
foreach(Folder* folder, this->map().values()) { foreach(Folder* folder, this->map().values()) {
QString path = folder->cleanPath(); QString path = folder->cleanPath();
QString remRelPath; QString remRelPath;
// cut off the remote path from the server path.
remRelPath = relPath.mid(folder->remotePath().length()); remRelPath = relPath.mid(folder->remotePath().length());
path += remRelPath; path += remRelPath;