From a2c37d6435731942b4cb1e2509ddaba68da11152 Mon Sep 17 00:00:00 2001
From: James Crook <james.k.crook@gmail.com>
Date: Wed, 3 Jan 2018 15:10:58 +0000
Subject: [PATCH] Some Doxygen comments

I'm testing out some ideas on using doxygen more, and these sample
changes will help with that.
---
 src/Menus.cpp | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/src/Menus.cpp b/src/Menus.cpp
index 7b83124d4..bd05fc233 100644
--- a/src/Menus.cpp
+++ b/src/Menus.cpp
@@ -1598,6 +1598,9 @@ void AudacityProject::CreateMenusAndCommands()
 #endif
 }
 
+/// The effects come from a plug in list
+/// This code iterates through the list, adding effects into
+/// the menu.
 void AudacityProject::PopulateEffectsMenu(CommandManager* c,
                                           EffectType type,
                                           CommandFlag batchflags,
@@ -2182,6 +2185,8 @@ CommandFlag AudacityProject::GetUpdateFlags(bool checkActive)
    return flags;
 }
 
+// Select the full time range, if no
+// time range is selected.
 void AudacityProject::SelectAllIfNone()
 {
    auto flags = GetUpdateFlags();
@@ -2190,6 +2195,7 @@ void AudacityProject::SelectAllIfNone()
       OnSelectSomething();
 }
 
+// Stop playing or recording, if paused.
 void AudacityProject::StopIfPaused()
 {
    auto flags = GetUpdateFlags();
@@ -2359,6 +2365,7 @@ void AudacityProject::UpdateMenus(bool checkActive)
 // Tool selection commands
 //
 
+/// Called by handlers that set tools.
 void AudacityProject::SetTool(int tool)
 {
    ToolsToolBar *toolbar = GetToolsToolBar();
@@ -2368,21 +2375,25 @@ void AudacityProject::SetTool(int tool)
    }
 }
 
+/// Handler to set the select tool active
 void AudacityProject::OnSelectTool()
 {
    SetTool(selectTool);
 }
 
+/// Handler to set the Zoom tool active
 void AudacityProject::OnZoomTool()
 {
    SetTool(zoomTool);
 }
 
+/// Handler to set the Envelope tool active
 void AudacityProject::OnEnvelopeTool()
 {
    SetTool(envelopeTool);
 }
 
+/// Handler to set the Time shift tool active
 void AudacityProject::OnTimeShiftTool()
 {
    SetTool(slideTool);
@@ -3831,8 +3842,8 @@ void AudacityProject::PrevWindow()
 #endif
 }
 
-//The following methods operate controls on specified tracks,
-//This will pop up the track panning dialog for specified track
+///The following methods operate controls on specified tracks,
+///This will pop up the track panning dialog for specified track
 void AudacityProject::OnTrackPan()
 {
    Track *const track = mTrackPanel->GetFocusedTrack();