From: Alberto Villa <avilla@FreeBSD.org>
Date: Fri, 14 May 2010 10:47:21 +0000 (+0000)
Subject: - Document and reindent.
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=1513be73305aeab04ae7810a7f5078bcdc763283;p=kdenlive

- Document and reindent.

svn path=/trunk/kdenlive/; revision=4440
---

diff --git a/src/effectslist.h b/src/effectslist.h
index 220174f0..f60c50ab 100644
--- a/src/effectslist.h
+++ b/src/effectslist.h
@@ -15,29 +15,46 @@
  *                                                                         *
  ***************************************************************************/
 
+/**
+ * @class EffectsList
+ * @brief List for effects objects.
+ * @author Jason Wood
+ *
+ * This is a list of DocClipBase objects, to be used instead of
+ * QList<DocClipBase> to enable sorting lists correctly. It also contains the
+ * ability to set a "master clip", which can be used by a number of operations
+ * where there is the need of one clip to act as a reference for what happens to
+ * all clips.
+ */
+
 #ifndef EFFECTSLIST_H
 #define EFFECTSLIST_H
 
 #include <QDomDocument>
 
-/**A List for DocClipBase objects. Use this instead of QList<DocClipBase> so as to sort lists correctly.
- * Also contains the ability to set a "master clip", which can be used by a number of operations where
- * the need for one clip to act as a reference for what happens to all clips is needed.
-  * @author Jason Wood
-  */
-
-
 class EffectsList: public QDomDocument
 {
 public:
     EffectsList();
     ~EffectsList();
-    /** Returns an XML version of this Effect.*/
+
+    /** @brief Returns the XML element of an effect.
+     * @param name name of the effect to be returned */
     QDomElement getEffectByName(const QString & name) const;
     QDomElement getEffectByTag(const QString & tag, const QString & id) const;
-    /** if the list contains effect defined by tag + id, returns effect index, otherwise -1 */
+
+    /** @brief Checks the existance of an effect.
+     * @param tag effect tag
+     * @param id effect id
+     * @return effect index if the effect exists, -1 otherwise */
     int hasEffect(const QString & tag, const QString & id) const;
+
+    /** @brief Lists the core properties of an effect.
+     * @param ix effect index
+     * @return list of name, tag and id of an effect */
     QStringList effectIdInfo(const int ix) const;
+
+    /** @brief Lists effects names. */
     QStringList effectNames();
     QString getInfo(const QString & tag, const QString & id) const;
     QString getInfoFromIndex(const int ix) const;
diff --git a/src/recmonitor.h b/src/recmonitor.h
index 2f15aae3..1ab5b6e4 100644
--- a/src/recmonitor.h
+++ b/src/recmonitor.h
@@ -19,7 +19,7 @@
 
 /**
 * @class RecMonitor
-* @brief Records video via dvgrab, video4linux and recordmydesktop 
+* @brief Records video via dvgrab, video4linux and recordmydesktop
 * @author Jean-Baptiste Mardelle
 */
 
diff --git a/src/trackview.cpp b/src/trackview.cpp
index ac1c2f41..a2f2de4e 100644
--- a/src/trackview.cpp
+++ b/src/trackview.cpp
@@ -944,7 +944,8 @@ void TrackView::slotRenameTrack(int ix)
     }
 }
 
-void TrackView::slotUpdateVerticalScroll(int /*min*/, int max) {
+void TrackView::slotUpdateVerticalScroll(int /*min*/, int max)
+{
     int height = 0;
     if (max > 0) height = m_trackview->horizontalScrollBar()->height() - 1;
     headers_container->layout()->setContentsMargins(0, m_trackview->frameWidth(), 0, height);