1
0
mirror of https://github.com/cookiengineer/audacity synced 2025-10-19 17:11:12 +02:00

More doxygen

This commit is contained in:
James Crook
2018-11-03 13:17:54 +00:00
parent f9627864c0
commit 7030c9fc4f
43 changed files with 131 additions and 56 deletions

View File

@@ -13,6 +13,10 @@
#include <wx/dcmemory.h>
#include "wxPanelWrapper.h"
/// \brief BackedPanel is for a panel that consists of a bitmap with something drawn
/// obver it. It supports efficient repainting when the overlays change and
/// recreation of the bitmap when the panel size is changed.
class AUDACITY_DLL_API BackedPanel /* not final */ : public wxPanelWrapper {
public:
BackedPanel(wxWindow * parent, wxWindowID id,

View File

@@ -18,6 +18,12 @@
\brief The widget to the left of a ToolBar that allows it to be dragged
around to NEW positions.
*//*******************************************************************//**
\class AStaticBitmap
\brief A widget for bitmaps which ignores the erase event for
flicker-free use.
*//**********************************************************************/
#ifndef __AUDACITY_WIDGETS_GRABBER__

View File

@@ -33,11 +33,12 @@ class GridAx;
class NumericTextCtrl;
using NumericFormatId = ComponentInterfaceSymbol;
// ----------------------------------------------------------------------------
// NumericEditor
//
// wxGridCellEditor for the NumericTextCtrl.
// ----------------------------------------------------------------------------
/**********************************************************************//**
\class NumericEditor
\brief wxGridCellEditor for the NumericTextCtrl.
**************************************************************************/
#define GRID_VALUE_TIME wxT("Time")
#define GRID_VALUE_FREQUENCY wxT("Frequency")
@@ -86,12 +87,10 @@ public:
wxString mValueAsString;
};
// ----------------------------------------------------------------------------
// NumericRenderer
//
// wxGridCellRenderer for the NumericTextCtrl.
// ----------------------------------------------------------------------------
/**********************************************************************//**
\class NumericRenderer
\brief wxGridCellRenderer for the NumericTextCtrl.
**************************************************************************/
class NumericRenderer final : public wxGridCellRenderer
{
public:
@@ -118,11 +117,11 @@ private:
NumericConverter::Type mType;
};
// ----------------------------------------------------------------------------
// ChoiceEditor
//
// Modified version of wxGridChoiceEditor using wxChoice instead of wxComboBox.
// ----------------------------------------------------------------------------
/**********************************************************************//**
\class ChoiceEditor
\brief Modified version of wxGridChoiceEditor using wxChoice instead of
wxComboBox.
**************************************************************************/
#define GRID_VALUE_CHOICE wxT("Choice")
class ChoiceEditor final : public wxGridCellEditor, wxEvtHandler
@@ -184,11 +183,10 @@ public:
wxString mValueAsString;
};
// ----------------------------------------------------------------------------
// Grid
//
// wxGrid with support for accessibility.
// ----------------------------------------------------------------------------
/**********************************************************************//**
\class Grid
\brief wxGrid with support for accessibility.
**************************************************************************/
class Grid final : public wxGrid
{
@@ -236,12 +234,10 @@ class Grid final : public wxGrid
};
#if wxUSE_ACCESSIBILITY
// ----------------------------------------------------------------------------
// GridAx
//
// wxAccessible object providing grid information for Grid.
// ----------------------------------------------------------------------------
/**********************************************************************//**
\class GridAx
\brief wxAccessible object providing grid information for Grid.
**************************************************************************/
class GridAx final : public WindowAccessible
{

View File

@@ -24,6 +24,10 @@
void OpenInDefaultBrowser(const wxHtmlLinkInfo& link);
/// \brief An HtmlWindow that handles linked clicked - usually the
/// link will go to our own local copy of the manual, but it could
/// launch a new browser window.
class AUDACITY_DLL_API LinkingHtmlWindow final : public HtmlWindow
{
public:
@@ -36,6 +40,8 @@ class AUDACITY_DLL_API LinkingHtmlWindow final : public HtmlWindow
};
/// Adds some event handling to an HtmlWindow
class BrowserDialog /* not final */ : public wxDialogWrapper
{
public: