From: Mads Bondo Dydensborg <mads@dydensborg.dk>
Date: Thu, 1 Jan 2009 20:44:51 +0000 (+0000)
Subject: Added some documentation
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=c0a967cd1269468a65607c6d1a427dd226ed15f4;p=kdenlive

Added some documentation

svn path=/branches/KDE4/; revision=2862
---

diff --git a/src/titlewidget.h b/src/titlewidget.h
index 866d737d..9d777050 100644
--- a/src/titlewidget.h
+++ b/src/titlewidget.h
@@ -45,10 +45,27 @@ class TitleWidget : public QDialog , public Ui::TitleWidget_UI {
     Q_OBJECT
 
 public:
+    /** \brief Constructor
+     * \param projectPath Path to use when user requests loading or saving of titles as .kdenlivetitle documents */
     TitleWidget(KUrl url, QString projectPath, Render *render, QWidget *parent = 0);
     QDomDocument xml();
     void setXml(QDomDocument doc);
+    
+    /** \brief Find first available filename of the form titleXXX.png in projectUrl + "/titles/" directory
+    * \param projectUrl Url to directory of project. 
+     * \returns A list, with the name in the form of "/path/to/titles/titleXXX" as the first element, the extension
+     * ".png" as the second element.
+     * 
+     * The path "/titles/" is appended to projectUrl to locate the actual directory that contains the title pngs. */
     static QStringList getFreeTitleInfo(const KUrl &projectUrl);
+    
+    /** \brief Build a filename from a projectUrl and a titleName
+     * \param projectUrl Url to directory of project.
+     * \param titleName Name of title, on the form "titleXXX"
+     * 
+     * The path "/titles/" is appended to projectUrl to build the directoryname, then .pgn is appended to
+     * get the filename. It is not checked that the title png actually exists, only the name is build and
+     * returned. */
     static QString getTitleResourceFromName(const KUrl &projectUrl, const QString &titleName);
 
 protected: