[Pkg-owncloud-commits] [owncloud-client] 327/484: Added some documentation.

[Sandro Knauß]

This is an automated email from the git hooks/post-receive script.

hefee-guest pushed a commit to branch master
in repository owncloud-client.

commit ff76a842d04e63f0f661569b6cfffbc55627b37b
Author: Klaas Freitag <freitag at owncloud.com>
Date:   Mon Nov 16 15:38:08 2015 +0100

    Added some documentation.
---
 src/gui/activitywidget.cpp |  3 ++-
 src/gui/activitywidget.h   | 27 +++++++++++++++++++++++++--
 src/gui/folderman.cpp      |  1 +
 3 files changed, 28 insertions(+), 3 deletions(-)

diff --git a/src/gui/activitywidget.cpp b/src/gui/activitywidget.cpp
index 930fd87..cbb06db 100644
--- a/src/gui/activitywidget.cpp
+++ b/src/gui/activitywidget.cpp
@@ -50,7 +50,7 @@ QString ActivityList::accountName() const
     return _accountName;
 }
 
-// ========================================================================
+/* ==================================================================== */
 
 ActivityListModel::ActivityListModel(QWidget *parent)
     :QAbstractListModel(parent)
@@ -374,6 +374,7 @@ void ActivityWidget::slotOpenFile(QModelIndex indx)
     }
 }
 
+/* ==================================================================== */
 
 ActivitySettings::ActivitySettings(QWidget *parent)
     :QWidget(parent)
diff --git a/src/gui/activitywidget.h b/src/gui/activitywidget.h
index 90aebd0..7949a74 100644
--- a/src/gui/activitywidget.h
+++ b/src/gui/activitywidget.h
@@ -40,8 +40,10 @@ namespace Ui {
 class Application;
 
 /**
- * @brief The ActivityListModel
+ * @brief Activity Structure
  * @ingroup gui
+ *
+ * contains all the information describing a single activity.
  */
 
 class Activity
@@ -66,6 +68,12 @@ public:
 
 };
 
+/**
+ * @brief The ActivityList
+ * @ingroup gui
+ *
+ * A QList based list of Activities
+ */
 class ActivityList:public QList<Activity>
 {
     // 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
 {
     Q_OBJECT
@@ -113,6 +126,9 @@ private:
 /**
  * @brief The ActivityWidget class
  * @ingroup gui
+ *
+ * The list widget to display the activities, contained in the
+ * subsequent ActivitySettings widget.
  */
 
 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
 {
     Q_OBJECT
diff --git a/src/gui/folderman.cpp b/src/gui/folderman.cpp
index 5930cf0..d69fbf8 100644
--- a/src/gui/folderman.cpp
+++ b/src/gui/folderman.cpp
@@ -837,6 +837,7 @@ QStringList FolderMan::findFileInLocalFolders( const QString& relPath )
     foreach(Folder* folder, this->map().values()) {
         QString path = folder->cleanPath();
         QString remRelPath;
+        // cut off the remote path from the server path.
         remRelPath = relPath.mid(folder->remotePath().length());
         path += remRelPath;
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-client.git