Consistently use @see in Doxygen documentation
Although @see was used predominantly, a few places used @sa which is equivalent to it but less readable, so switch to using @see everywhere. No real changes.
This commit is contained in:
parent
9f55d568c2
commit
95f16e63d2
6 changed files with 24 additions and 24 deletions
|
|
@ -20,7 +20,7 @@ overhead of using the critical section is not needed. To solve this problem,
|
||||||
the wxCRITICAL_SECTION() macro may be used to create and use the critical
|
the wxCRITICAL_SECTION() macro may be used to create and use the critical
|
||||||
section only when needed.
|
section only when needed.
|
||||||
|
|
||||||
@sa wxThread, wxMutex, @ref overview_thread
|
@see wxThread, wxMutex, @ref overview_thread
|
||||||
|
|
||||||
Related class group: @ref group_class_threading
|
Related class group: @ref group_class_threading
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -366,9 +366,9 @@ public:
|
||||||
|
|
||||||
@note This operation also changes the name in the pane information!
|
@note This operation also changes the name in the pane information!
|
||||||
|
|
||||||
@sa LoadPerspective
|
@see LoadPerspective
|
||||||
@sa SavePaneInfo().
|
@see SavePaneInfo()
|
||||||
@sa SavePerspective
|
@see SavePerspective
|
||||||
*/
|
*/
|
||||||
void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo& pane);
|
void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo& pane);
|
||||||
|
|
||||||
|
|
@ -386,9 +386,9 @@ public:
|
||||||
@param update If update is @true, wxAuiManager::Update() is automatically invoked,
|
@param update If update is @true, wxAuiManager::Update() is automatically invoked,
|
||||||
thus realizing the specified perspective on screen.
|
thus realizing the specified perspective on screen.
|
||||||
|
|
||||||
@sa LoadPaneInfo
|
@see LoadPaneInfo
|
||||||
@sa LoadPerspective
|
@see LoadPerspective
|
||||||
@sa SavePerspective
|
@see SavePerspective
|
||||||
*/
|
*/
|
||||||
bool LoadPerspective(const wxString& perspective,
|
bool LoadPerspective(const wxString& perspective,
|
||||||
bool update = true);
|
bool update = true);
|
||||||
|
|
@ -417,9 +417,9 @@ public:
|
||||||
the string. Information about the pointers to UI elements stored
|
the string. Information about the pointers to UI elements stored
|
||||||
in the pane are not serialized.
|
in the pane are not serialized.
|
||||||
|
|
||||||
@sa LoadPaneInfo
|
@see LoadPaneInfo
|
||||||
@sa LoadPerspective
|
@see LoadPerspective
|
||||||
@sa SavePerspective
|
@see SavePerspective
|
||||||
*/
|
*/
|
||||||
wxString SavePaneInfo(const wxAuiPaneInfo& pane);
|
wxString SavePaneInfo(const wxAuiPaneInfo& pane);
|
||||||
|
|
||||||
|
|
@ -427,9 +427,9 @@ public:
|
||||||
Saves the entire user interface layout into an encoded wxString, which
|
Saves the entire user interface layout into an encoded wxString, which
|
||||||
can then be stored by the application (probably using wxConfig).
|
can then be stored by the application (probably using wxConfig).
|
||||||
|
|
||||||
@sa LoadPerspective
|
@see LoadPerspective
|
||||||
@sa LoadPaneInfo
|
@see LoadPaneInfo
|
||||||
@sa SavePaneInfo
|
@see SavePaneInfo
|
||||||
*/
|
*/
|
||||||
wxString SavePerspective();
|
wxString SavePerspective();
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4374,14 +4374,14 @@ public:
|
||||||
needs to be saved. The widths can be later restored using
|
needs to be saved. The widths can be later restored using
|
||||||
SetColSizes().
|
SetColSizes().
|
||||||
|
|
||||||
@sa wxGridSizesInfo, GetRowSizes()
|
@see wxGridSizesInfo, GetRowSizes()
|
||||||
*/
|
*/
|
||||||
wxGridSizesInfo GetColSizes() const;
|
wxGridSizesInfo GetColSizes() const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Get size information for all row at once.
|
Get size information for all row at once.
|
||||||
|
|
||||||
@sa wxGridSizesInfo, GetColSizes()
|
@see wxGridSizesInfo, GetColSizes()
|
||||||
*/
|
*/
|
||||||
wxGridSizesInfo GetRowSizes() const;
|
wxGridSizesInfo GetRowSizes() const;
|
||||||
|
|
||||||
|
|
@ -4391,14 +4391,14 @@ public:
|
||||||
This is usually called with wxGridSizesInfo object previously returned
|
This is usually called with wxGridSizesInfo object previously returned
|
||||||
by GetColSizes().
|
by GetColSizes().
|
||||||
|
|
||||||
@sa SetRowSizes()
|
@see SetRowSizes()
|
||||||
*/
|
*/
|
||||||
void SetColSizes(const wxGridSizesInfo& sizeInfo);
|
void SetColSizes(const wxGridSizesInfo& sizeInfo);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Restore all rows sizes.
|
Restore all rows sizes.
|
||||||
|
|
||||||
@sa SetColSizes()
|
@see SetColSizes()
|
||||||
*/
|
*/
|
||||||
void SetRowSizes(const wxGridSizesInfo& sizeInfo);
|
void SetRowSizes(const wxGridSizesInfo& sizeInfo);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -410,7 +410,7 @@ public:
|
||||||
@param rect
|
@param rect
|
||||||
The rectangle within which to draw.
|
The rectangle within which to draw.
|
||||||
|
|
||||||
@sa GetPageBackgroundRedrawArea
|
@see GetPageBackgroundRedrawArea
|
||||||
*/
|
*/
|
||||||
virtual void DrawPageBackground(
|
virtual void DrawPageBackground(
|
||||||
wxDC& dc,
|
wxDC& dc,
|
||||||
|
|
@ -800,7 +800,7 @@ public:
|
||||||
The offset where the client rectangle begins within the panel (may
|
The offset where the client rectangle begins within the panel (may
|
||||||
be @NULL).
|
be @NULL).
|
||||||
|
|
||||||
@sa GetPanelClientSize()
|
@see GetPanelClientSize()
|
||||||
*/
|
*/
|
||||||
virtual wxSize GetPanelSize(
|
virtual wxSize GetPanelSize(
|
||||||
wxDC& dc,
|
wxDC& dc,
|
||||||
|
|
@ -823,7 +823,7 @@ public:
|
||||||
The offset where the returned client size begins within the given
|
The offset where the returned client size begins within the given
|
||||||
@a size (may be @NULL).
|
@a size (may be @NULL).
|
||||||
|
|
||||||
@sa GetPanelSize()
|
@see GetPanelSize()
|
||||||
*/
|
*/
|
||||||
virtual wxSize GetPanelClientSize(
|
virtual wxSize GetPanelClientSize(
|
||||||
wxDC& dc,
|
wxDC& dc,
|
||||||
|
|
@ -860,7 +860,7 @@ public:
|
||||||
@param client_size
|
@param client_size
|
||||||
The client size.
|
The client size.
|
||||||
|
|
||||||
@sa GetGalleryClientSize()
|
@see GetGalleryClientSize()
|
||||||
*/
|
*/
|
||||||
virtual wxSize GetGallerySize(
|
virtual wxSize GetGallerySize(
|
||||||
wxDC& dc,
|
wxDC& dc,
|
||||||
|
|
|
||||||
|
|
@ -132,8 +132,8 @@ public:
|
||||||
After all pages have been created, and all controls and panels placed on
|
After all pages have been created, and all controls and panels placed on
|
||||||
those pages, Realize() must be called.
|
those pages, Realize() must be called.
|
||||||
|
|
||||||
@sa wxRibbonPage
|
@see wxRibbonPage
|
||||||
@sa wxRibbonPanel
|
@see wxRibbonPanel
|
||||||
|
|
||||||
@beginStyleTable
|
@beginStyleTable
|
||||||
@style{wxRIBBON_BAR_DEFAULT_STYLE}
|
@style{wxRIBBON_BAR_DEFAULT_STYLE}
|
||||||
|
|
|
||||||
|
|
@ -71,7 +71,7 @@ wxEventType wxEVT_RIBBONPANEL_EXTBUTTON_ACTIVATED;
|
||||||
it is recommended that ribbon and non ribbon controls are not mixed in one
|
it is recommended that ribbon and non ribbon controls are not mixed in one
|
||||||
panel.
|
panel.
|
||||||
|
|
||||||
@sa wxRibbonPage
|
@see wxRibbonPage
|
||||||
|
|
||||||
@beginStyleTable
|
@beginStyleTable
|
||||||
@style{wxRIBBON_PANEL_DEFAULT_STYLE}
|
@style{wxRIBBON_PANEL_DEFAULT_STYLE}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue