More doxygen

src/prefs/BatchPrefs.cpp

@@ -10,8 +10,8 @@
 *******************************************************************//**
 
 \class BatchPrefs
-\brief A PrefsPanel that builds up a chain of effects in MacroCommands
-
+\brief A probably unused PrefsPanel that in debug builds could offer a 
+setting used in debugging batch (aka macros) processing.
 *//*******************************************************************/
 
 #include "../Audacity.h"

src/prefs/BatchPrefs.h

@@ -34,6 +34,8 @@ private:
    DECLARE_EVENT_TABLE()
 };
 
+
+/// A PrefsPanelFactory that creates one BatchPrefs panel.
 class BatchPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/DevicePrefs.h

@@ -54,6 +54,7 @@ class DevicePrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one DevicePrefs panel.
 class DevicePrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/DirectoriesPrefs.h

@@ -39,6 +39,7 @@ class DirectoriesPrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one DirectoriesPrefs panel.
 class DirectoriesPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/EffectsPrefs.h

@@ -35,6 +35,7 @@ class EffectsPrefs final : public PrefsPanel
    void Populate();
 };
 
+/// A PrefsPanelFactory that creates one EffectsPrefs panel.
 class EffectsPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/ExtImportPrefs.h

@@ -108,6 +108,7 @@ class ExtImportPrefs final : public PrefsPanel
 };
 
 
+/// A PrefsPanelFactory that creates one ExtImportPrefs panel.
 class ExtImportPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/GUIPrefs.h

@@ -49,6 +49,7 @@ class GUIPrefs final : public PrefsPanel
    wxArrayString mRangeChoices;
 };
 
+/// A PrefsPanelFactory that creates one GUIPrefs panel.
 class GUIPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/ImportExportPrefs.h

@@ -34,6 +34,7 @@ class ImportExportPrefs final : public PrefsPanel
    void Populate();
 };
 
+/// A PrefsPanelFactory that creates one ImportExportPrefs panel.
 class ImportExportPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/KeyConfigPrefs.h

@@ -94,6 +94,7 @@ private:
 };
 
 
+/// A PrefsPanelFactory that creates one KeyConfigPrefs panel.
 class KeyConfigPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/LibraryPrefs.h

@@ -47,6 +47,7 @@ class LibraryPrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one LibraryPrefs panel.
 class LibraryPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/MidiIOPrefs.h

@@ -63,6 +63,7 @@ class MidiIOPrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one MidiIOPrefs panel.
 class MidiIOPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/ModulePrefs.h

@@ -51,6 +51,7 @@ class ModulePrefs final : public PrefsPanel
    wxArrayString mPaths;
 };
 
+/// A PrefsPanelFactory that creates one ModulePrefs panel.
 class ModulePrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/MousePrefs.h

@@ -39,6 +39,7 @@ class MousePrefs final : public PrefsPanel
    wxListCtrl * mList;
 };
 
+/// A PrefsPanelFactory that creates one MousePrefs panel.
 class MousePrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/PlaybackPrefs.h

@@ -35,6 +35,8 @@ class PlaybackPrefs final : public PrefsPanel
    void Populate();
 };
 
+
+/// A PrefsPanelFactory that creates one PlaybackPrefs panel.
 class PlaybackPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/PrefsPanel.h

@@ -9,10 +9,9 @@
 *******************************************************************//**
 
 \class PrefsPanel
-\brief Used within the PrefsDialog, classes derived from this class
-include AudioIOPrefs, BatchPrefs, DirectoriesPrefs, FileFormatPrefs,
-GUIPrefs, KeyConfigPrefs, MousePrefs, QualityPrefs, SpectrumPrefs and
-ThemePrefs.
+\brief Base class for a panel in the PrefsDialog.  Classes derived from 
+this class include BatchPrefs, DirectoriesPrefs, GUIPrefs, KeyConfigPrefs, 
+MousePrefs, QualityPrefs, SpectrumPrefs and ThemePrefs.
 
   The interface works like this: Each panel in the preferences dialog
   must derive from PrefsPanel. You must override Apply() with code
@@ -20,9 +19,15 @@ ThemePrefs.
   global preferences object gPrefs, and instructing the applicable parts
   of the program to re-read the preference options.
 
-  To actually add a the NEW panel, edit the PrefsDialog constructor
+  To actually add the new panel, edit the PrefsDialog constructor
   to append the panel to its list of panels.
 
+*******************************************************************//**
+
+\class PrefsPanelFactory
+\brief Base class for factories such as GUIPrefsFactory that produce a
+PrefsPanel.
+
 *//*******************************************************************/
 
 #ifndef __AUDACITY_PREFS_PANEL__

src/prefs/ProjectsPrefs.h

@@ -34,6 +34,7 @@ class ProjectsPrefs final : public PrefsPanel
    void Populate();
 };
 
+/// A PrefsPanelFactory that creates one ProjectPrefs panel.
 class ProjectsPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/QualityPrefs.h

@@ -55,6 +55,7 @@ class QualityPrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one QualityPrefs panel.
 class QualityPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/RecordingPrefs.h

@@ -41,6 +41,7 @@ class RecordingPrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one RecordingPrefs panel.
 class RecordingPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/SpectrumPrefs.h

@@ -104,6 +104,7 @@ class SpectrumPrefs final : public PrefsPanel
    bool mCommitted{};
 };
 
+/// A PrefsPanelFactory that creates one SpectrumPrefs panel.
 class SpectrumPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/ThemePrefs.h

@@ -41,6 +41,7 @@ class ThemePrefs final : public PrefsPanel
    DECLARE_EVENT_TABLE()
 };
 
+/// A PrefsPanelFactory that creates one ThemePrefs panel.
 class ThemePrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/TracksBehaviorsPrefs.h

@@ -37,6 +37,7 @@ class TracksBehaviorsPrefs final : public PrefsPanel
    wxArrayString mSoloChoices;
 };
 
+/// A PrefsPanelFactory that creates one TracksBehaviorsPrefs panel.
 class TracksBehaviorsPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/TracksPrefs.h

@@ -52,6 +52,7 @@ class TracksPrefs final : public PrefsPanel
    static int iPreferencePinned;
 };
 
+/// A PrefsPanelFactory that creates one TracksPrefs panel.
 class TracksPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/WarningsPrefs.h

@@ -34,6 +34,7 @@ class WarningsPrefs final : public PrefsPanel
    void PopulateOrExchange(ShuttleGui & S) override;
 };
 
+/// A PrefsPanelFactory that creates one WarningPrefs panel.
 class WarningsPrefsFactory final : public PrefsPanelFactory
 {
 public:

src/prefs/WaveformPrefs.h

@@ -56,6 +56,7 @@ private:
    bool mPopulating;
 };
 
+/// A PrefsPanelFactory that creates one WaveformPrefs panel.
 class WaveformPrefsFactory final : public PrefsPanelFactory
 {
 public: