Merge the 'devel/dh/doccleanup' branch into master.

The majority of these changes are to the documentation itself, either adding documentation or correcting nits that throw off the doxygen parser. There are a couple of places where variable names were changed to match up declaration and definition and code. This patch also adds semicolons after a number of macro calls. While not needed by the compiler, the lack of a semicolon completely throws off the doxygen parser. Upgrade the doxygen configuration file to the latest version. Fixes #13107.
MythTV · Oct 12, 2017 · 14486bc · 14486bc
2 parents f7d4ab0 + 290a09b
commit 14486bc
Show file tree

Hide file tree

Showing 218 changed files with 1,162 additions and 827 deletions.
diff --git a/mythplugins/mytharchive/mytharchive/archivesettings.h b/mythplugins/mytharchive/mytharchive/archivesettings.h
@@ -14,7 +14,7 @@
 
 class ArchiveSettings : public GroupSetting
 {
-    Q_DECLARE_TR_FUNCTIONS(ArchiveSettings)
+    Q_DECLARE_TR_FUNCTIONS(ArchiveSettings);
 
   public:
     ArchiveSettings();

diff --git a/mythplugins/mythgallery/dcrawplugin/dcrawplugin.h b/mythplugins/mythgallery/dcrawplugin/dcrawplugin.h
@@ -10,7 +10,7 @@ class DcrawPlugin : public QImageIOPlugin
     Q_OBJECT
 #if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
     Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QImageIOHandlerFactoryInterface"
-                      FILE "raw.json")
+                      FILE "raw.json");
 #endif
 
 public:
@@ -23,4 +23,4 @@ class DcrawPlugin : public QImageIOPlugin
 #if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
     // This shouldn't be necessary, but it shuts up the dang compiler warning.
     const QStaticPlugin qt_static_plugin_DcrawPlugin();
-#endif
+#endif
diff --git a/mythplugins/mythgallery/mythgallery/gallerysettings.h b/mythplugins/mythgallery/mythgallery/gallerysettings.h
@@ -8,7 +8,7 @@
 
 class GallerySettings : public GroupSetting
 {
-    Q_DECLARE_TR_FUNCTIONS(GallerySettings)
+    Q_DECLARE_TR_FUNCTIONS(GallerySettings);
 
   public:  
     GallerySettings();

diff --git a/mythplugins/mythgallery/mythgallery/iconview.h b/mythplugins/mythgallery/mythgallery/iconview.h
@@ -46,7 +46,7 @@ class ThumbGenerator;
 class MediaMonitor;
 class ChildCountThread;
 
-Q_DECLARE_METATYPE(ThumbItem*)
+Q_DECLARE_METATYPE(ThumbItem*);
 
 class IconView : public MythScreenType
 {

diff --git a/mythplugins/mythgallery/mythgallery/imageview.h b/mythplugins/mythgallery/mythgallery/imageview.h
@@ -51,7 +51,7 @@ private slots:
 
 class ImageView
 {
-     Q_DECLARE_TR_FUNCTIONS(ImageView)
+     Q_DECLARE_TR_FUNCTIONS(ImageView);
 
   public:
     ImageView(const ThumbList &itemList,

diff --git a/mythplugins/mythgame/mythgame/gamesettings.h b/mythplugins/mythgame/mythgame/gamesettings.h
@@ -61,7 +61,7 @@ class GameDBStorage : public SimpleDBStorage
 
 class MythGameGeneralSettings : public GroupSetting
 {
-    Q_DECLARE_TR_FUNCTIONS(MythGameGeneralSettings)
+    Q_DECLARE_TR_FUNCTIONS(MythGameGeneralSettings);
 
   public:
     MythGameGeneralSettings();

diff --git a/mythplugins/mythmusic/mythmusic/cddb.cpp b/mythplugins/mythmusic/mythmusic/cddb.cpp
@@ -29,23 +29,22 @@ const int SECS_PER_MIN = 60;
 static const char URL[] = "http://freedb.musicbrainz.org/~cddb/cddb.cgi?cmd=";
 static const QString& helloID();
 
-namespace {
 /*
  * Local cddb database
  */
 struct Dbase
 {
-    static bool Search(Cddb::Matches&, Cddb::discid_t);
-    static bool Search(Cddb::Album&, const QString& genre, Cddb::discid_t);
-    static bool Write(const Cddb::Album&);
+    static bool Search(Cddb::Matches& res, const Cddb::discid_t discID);
+    static bool Search(Cddb::Album& a, const QString& genre, const Cddb::discid_t discID);
+    static bool Write(const Cddb::Album& album);
 
-    static void New(Cddb::discid_t, const Cddb::Toc&);
-    static void MakeAlias(const Cddb::Album&, const Cddb::discid_t);
+    static void New(const Cddb::discid_t discID, const Cddb::Toc& toc);
+    static void MakeAlias(const Cddb::Album& album, const Cddb::discid_t discID);
 
 private:
-    static bool CacheGet(Cddb::Matches&, Cddb::discid_t);
-    static bool CacheGet(Cddb::Album&, const QString& genre, Cddb::discid_t);
-    static void CachePut(const Cddb::Album&);
+    static bool CacheGet(Cddb::Matches& res, const Cddb::discid_t discID);
+    static bool CacheGet(Cddb::Album& album, const QString& genre, const Cddb::discid_t discID);
+    static void CachePut(const Cddb::Album& album);
 
     // DiscID to album info cache
     typedef QMap< Cddb::discid_t, Cddb::Album > cache_t; 
@@ -54,7 +53,6 @@ struct Dbase
     static const QString& GetDB();
 };
 QMap< Cddb::discid_t, Cddb::Album > Dbase::s_cache;
-}
 
 
 /*

diff --git a/mythplugins/mythmusic/mythmusic/cddecoder.h b/mythplugins/mythmusic/mythmusic/cddecoder.h
@@ -19,7 +19,7 @@ class MusicMetadata;
 
 class CdDecoder : public Decoder
 {
-     Q_DECLARE_TR_FUNCTIONS(CdDecoder)
+     Q_DECLARE_TR_FUNCTIONS(CdDecoder);
 
   public:
     CdDecoder(const QString &file, DecoderFactory *, AudioOutput *);

diff --git a/mythplugins/mythmusic/mythmusic/cdrip.h b/mythplugins/mythmusic/mythmusic/cdrip.h
@@ -57,7 +57,7 @@ class RipStatus;
 
 class CDRipperThread: public MThread
 {
-    Q_DECLARE_TR_FUNCTIONS(CDRipperThread)
+    Q_DECLARE_TR_FUNCTIONS(CDRipperThread);
 
     public:
         CDRipperThread(RipStatus *parent,  QString device,

diff --git a/mythplugins/mythmusic/mythmusic/decoder.h b/mythplugins/mythmusic/mythmusic/decoder.h
@@ -122,7 +122,7 @@ class DecoderFactory
 
 class CdDecoderFactory : public DecoderFactory
 {
-    Q_DECLARE_TR_FUNCTIONS(CdDecoderFactory)
+    Q_DECLARE_TR_FUNCTIONS(CdDecoderFactory);
 
 public:
     bool supports(const QString &) const;
@@ -133,7 +133,7 @@ class CdDecoderFactory : public DecoderFactory
 
 class avfDecoderFactory : public DecoderFactory
 {
-    Q_DECLARE_TR_FUNCTIONS(avfDecoderFactory)
+    Q_DECLARE_TR_FUNCTIONS(avfDecoderFactory);
 
 public:
     bool supports(const QString &) const;

diff --git a/mythplugins/mythmusic/mythmusic/playlistcontainer.h b/mythplugins/mythmusic/mythmusic/playlistcontainer.h
@@ -29,7 +29,7 @@ class PlaylistLoadingThread : public MThread
 
 class PlaylistContainer
 {
-    Q_DECLARE_TR_FUNCTIONS(PlaylistContainer)
+    Q_DECLARE_TR_FUNCTIONS(PlaylistContainer);
 
   public:
     explicit PlaylistContainer(AllMusic *all_music);

diff --git a/mythplugins/mythmusic/mythmusic/playlisteditorview.h b/mythplugins/mythmusic/mythmusic/playlisteditorview.h
@@ -57,7 +57,7 @@ class MPUBLIC MusicGenericTree : public MythGenericTree
     //bool     m_active;
 };
 
-Q_DECLARE_METATYPE(MusicGenericTree*)
+Q_DECLARE_METATYPE(MusicGenericTree*);
 
 class PlaylistEditorView : public MusicCommon
 {

diff --git a/mythplugins/mythmusic/mythmusic/smartplaylist.h b/mythplugins/mythmusic/mythmusic/smartplaylist.h
@@ -42,7 +42,7 @@ QString formattedFieldValue(const QVariant &value);
 
 class SmartPLCriteriaRow
 {
-    Q_DECLARE_TR_FUNCTIONS(SmartPLCriteriaRow)
+    Q_DECLARE_TR_FUNCTIONS(SmartPLCriteriaRow);
 
   public:
 
@@ -65,7 +65,7 @@ class SmartPLCriteriaRow
     QString Value2;
 };
 
-Q_DECLARE_METATYPE(SmartPLCriteriaRow *)
+Q_DECLARE_METATYPE(SmartPLCriteriaRow *);
 
 class SmartPlaylistEditor : public MythScreenType
 {

diff --git a/mythplugins/mythmusic/mythmusic/visualize.h b/mythplugins/mythmusic/mythmusic/visualize.h
@@ -275,7 +275,7 @@ typedef struct piano_key_data {
 
 class AlbumArt : public VisualBase
 {
-    Q_DECLARE_TR_FUNCTIONS(AlbumArt)
+    Q_DECLARE_TR_FUNCTIONS(AlbumArt);
 
   public:
     AlbumArt(void);

diff --git a/mythplugins/mythnetvision/mythnetvision/rsseditor.cpp b/mythplugins/mythnetvision/mythnetvision/rsseditor.cpp
@@ -44,6 +44,9 @@ namespace
 }
 
 /** \brief Creates a new RSS Edit Popup
+ *  \param url The web page for which an entry is being created.
+ *  \param edit If true, then editing an existing entry instead of
+ *              creating a new entry.
  *  \param parent Pointer to the screen stack
  *  \param name The name of the window
  */

diff --git a/mythplugins/mythnews/mythnews/mythnewseditor.cpp b/mythplugins/mythnews/mythnews/mythnewseditor.cpp
@@ -20,6 +20,9 @@
 #define LOC_ERR  QString("MythNewsEditor, Error: ")
 
 /** \brief Creates a new MythNewsEditor Screen
+ *  \param site The web page for which an entry is being created.
+ *  \param edit If true, then editing an existing entry instead of
+ *              creating a new entry.
  *  \param parent Pointer to the screen stack
  *  \param name The name of the window
  */

diff --git a/mythplugins/mythweather/mythweather/weatherSetup.h b/mythplugins/mythweather/mythweather/weatherSetup.h
@@ -32,7 +32,7 @@ struct SourceListInfo
     uint id;
 };
 
-Q_DECLARE_METATYPE(SourceListInfo *)
+Q_DECLARE_METATYPE(SourceListInfo *);
 
 /** \class GlobalSetup
  *  \brief Screen for mythweather global settings

diff --git a/mythplugins/mythzoneminder/mythzoneminder/zmsettings.h b/mythplugins/mythzoneminder/mythzoneminder/zmsettings.h
@@ -11,7 +11,7 @@
 
 class ZMSettings : public GroupSetting
 {
-    Q_DECLARE_TR_FUNCTIONS(ZMSettings)
+    Q_DECLARE_TR_FUNCTIONS(ZMSettings);
 
   public:
     ZMSettings();