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:
Vadim Zeitlin 2023-02-20 23:01:00 +01:00
parent 9f55d568c2
commit 95f16e63d2
6 changed files with 24 additions and 24 deletions

View file

@ -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
section only when needed.
@sa wxThread, wxMutex, @ref overview_thread
@see wxThread, wxMutex, @ref overview_thread
Related class group: @ref group_class_threading

View file

@ -366,9 +366,9 @@ public:
@note This operation also changes the name in the pane information!
@sa LoadPerspective
@sa SavePaneInfo().
@sa SavePerspective
@see LoadPerspective
@see SavePaneInfo()
@see SavePerspective
*/
void LoadPaneInfo(wxString pane_part, wxAuiPaneInfo& pane);
@ -386,9 +386,9 @@ public:
@param update If update is @true, wxAuiManager::Update() is automatically invoked,
thus realizing the specified perspective on screen.
@sa LoadPaneInfo
@sa LoadPerspective
@sa SavePerspective
@see LoadPaneInfo
@see LoadPerspective
@see SavePerspective
*/
bool LoadPerspective(const wxString& perspective,
bool update = true);
@ -417,9 +417,9 @@ public:
the string. Information about the pointers to UI elements stored
in the pane are not serialized.
@sa LoadPaneInfo
@sa LoadPerspective
@sa SavePerspective
@see LoadPaneInfo
@see LoadPerspective
@see SavePerspective
*/
wxString SavePaneInfo(const wxAuiPaneInfo& pane);
@ -427,9 +427,9 @@ public:
Saves the entire user interface layout into an encoded wxString, which
can then be stored by the application (probably using wxConfig).
@sa LoadPerspective
@sa LoadPaneInfo
@sa SavePaneInfo
@see LoadPerspective
@see LoadPaneInfo
@see SavePaneInfo
*/
wxString SavePerspective();

View file

@ -4374,14 +4374,14 @@ public:
needs to be saved. The widths can be later restored using
SetColSizes().
@sa wxGridSizesInfo, GetRowSizes()
@see wxGridSizesInfo, GetRowSizes()
*/
wxGridSizesInfo GetColSizes() const;
/**
Get size information for all row at once.
@sa wxGridSizesInfo, GetColSizes()
@see wxGridSizesInfo, GetColSizes()
*/
wxGridSizesInfo GetRowSizes() const;
@ -4391,14 +4391,14 @@ public:
This is usually called with wxGridSizesInfo object previously returned
by GetColSizes().
@sa SetRowSizes()
@see SetRowSizes()
*/
void SetColSizes(const wxGridSizesInfo& sizeInfo);
/**
Restore all rows sizes.
@sa SetColSizes()
@see SetColSizes()
*/
void SetRowSizes(const wxGridSizesInfo& sizeInfo);

View file

@ -410,7 +410,7 @@ public:
@param rect
The rectangle within which to draw.
@sa GetPageBackgroundRedrawArea
@see GetPageBackgroundRedrawArea
*/
virtual void DrawPageBackground(
wxDC& dc,
@ -800,7 +800,7 @@ public:
The offset where the client rectangle begins within the panel (may
be @NULL).
@sa GetPanelClientSize()
@see GetPanelClientSize()
*/
virtual wxSize GetPanelSize(
wxDC& dc,
@ -823,7 +823,7 @@ public:
The offset where the returned client size begins within the given
@a size (may be @NULL).
@sa GetPanelSize()
@see GetPanelSize()
*/
virtual wxSize GetPanelClientSize(
wxDC& dc,
@ -860,7 +860,7 @@ public:
@param client_size
The client size.
@sa GetGalleryClientSize()
@see GetGalleryClientSize()
*/
virtual wxSize GetGallerySize(
wxDC& dc,

View file

@ -132,8 +132,8 @@ public:
After all pages have been created, and all controls and panels placed on
those pages, Realize() must be called.
@sa wxRibbonPage
@sa wxRibbonPanel
@see wxRibbonPage
@see wxRibbonPanel
@beginStyleTable
@style{wxRIBBON_BAR_DEFAULT_STYLE}

View file

@ -71,7 +71,7 @@ wxEventType wxEVT_RIBBONPANEL_EXTBUTTON_ACTIVATED;
it is recommended that ribbon and non ribbon controls are not mixed in one
panel.
@sa wxRibbonPage
@see wxRibbonPage
@beginStyleTable
@style{wxRIBBON_PANEL_DEFAULT_STYLE}