updated api documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@8488 90c681e8-e032-0410-971d-27865f9a5e38

2 files changed, 15 insertions, 5 deletions

diff --git a/src/qmmpui/metadataformatter.h b/src/qmmpui/metadataformatter.h
index 1a582b91c..2645e3fe7 100644
--- a/src/qmmpui/metadataformatter.h
+++ b/src/qmmpui/metadataformatter.h
@@ -78,12 +78,16 @@ public:
      */
     QString format(const PlayListTrack *item) const;
     /*!
-     * Converts metadata of \b TrackInfo pointer \b info to one string using template.
+     * Converts metadata of \b TrackInfo reference \b info to one string using template.
      * \param info pointer to \b TrackInfo object.
-     * \param track Index of track.
+     * \param trackIndex Index of track.
      */
     QString format(const TrackInfo &info, int trackIndex = 0) const;
-
+    /*!
+     * Converts metadata of \b TrackInfo pointer \b info to one string using template.
+     * \param info pointer to \b TrackInfo object.
+     * \param trackIndex Index of track.
+     */
     QString format(const TrackInfo *info, int trackIndex = 0) const;
     /*!
      * Returns formatted duration (example: 05:02:03).
@@ -91,6 +95,7 @@ public:
      * \param hideZero Setting for zero values output.
      * If \b hideZero is \b true, then the function outputs empty string for zero length,
      * otherwise outputs "0:00".
+     * \param showMs Adds milliseconds to the end of output (example: 05:02:03.324).
      */
     static QString formatDuration(qint64 duration, bool hideZero = true, bool showMs = false);
 
diff --git a/src/qmmpui/uihelper.h b/src/qmmpui/uihelper.h
index 46844e788..2ba17cc27 100644
--- a/src/qmmpui/uihelper.h
+++ b/src/qmmpui/uihelper.h
@@ -61,7 +61,7 @@ public:
     {
         TOOLS_MENU = 0, /*!< tools menu */
         PLAYLIST_MENU,  /*!< playlist context menu */
-        ADD_MENU
+        ADD_MENU        /*!< "add"/"file" menu */
     };
     /*!
      * Returns \b true if one of the general plugin can change visibility, otherwise returns \b false
@@ -89,8 +89,13 @@ public:
      * @param parent Parent widget
      */
     QMenu *createMenu(MenuType type, const QString &title = QString(), QWidget *parent = 0);
+    /*!
+     * Registers existing menu for access from general plugins.
+     * @param type Menu type.
+     * @param menu Menu pointer.
+     * @param before An action, after which the rest are added.
+     */
     void registerMenu(MenuType type, QMenu *menu, QAction *before = 0);
-
     /*!
      * Opens 'Add Files' dialog
      * @param parent Parent widget