From 3f7086de4c0bcfdc48d446db05c18e6721224f77 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 6 May 2014 18:16:29 +0000 Subject: [PATCH] Minor documentation corrections. Escape the space after "i.e." (or avoid using it altogether), add missing @ref. Closes #16235. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@76472 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/choice.h | 4 ++-- interface/wx/fontdlg.h | 2 +- interface/wx/hashset.h | 3 ++- interface/wx/hyperlink.h | 8 ++++---- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/interface/wx/choice.h b/interface/wx/choice.h index 25ad6bbfce..dac038fb3a 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -148,8 +148,8 @@ public: /** Unlike wxControlWithItems::GetSelection() which only returns the - accepted selection value, i.e. the selection in the control once the - user closes the dropdown list, this function returns the current + accepted selection value (the selection in the control once the + user closes the dropdown list), this function returns the current selection. That is, while the dropdown list is shown, it returns the currently selected item in it. When it is not shown, its result is the same as for the other function. diff --git a/interface/wx/fontdlg.h b/interface/wx/fontdlg.h index 88fc7e414a..710cdf9273 100644 --- a/interface/wx/fontdlg.h +++ b/interface/wx/fontdlg.h @@ -13,7 +13,7 @@ @library{wxcore} @category{cmndlg} - @see overview_cmndlg_font, wxFontData, wxGetFontFromUser() + @see @ref overview_cmndlg_font, wxFontData, wxGetFontFromUser() */ class wxFontDialog : public wxDialog { diff --git a/interface/wx/hashset.h b/interface/wx/hashset.h index dc5220347a..a7b19f5ae1 100644 --- a/interface/wx/hashset.h +++ b/interface/wx/hashset.h @@ -204,7 +204,8 @@ public: /** If an element with the given key is present, the functions returns an iterator pointing at that element, otherwise an invalid iterator - is returned; i.e. + is returned. + i.e. @code hashset.find( non_existent_key ) == hashset.end() @endcode diff --git a/interface/wx/hyperlink.h b/interface/wx/hyperlink.h index de28dd31a5..86433d4de1 100644 --- a/interface/wx/hyperlink.h +++ b/interface/wx/hyperlink.h @@ -148,7 +148,7 @@ public: /** Returns the colour used to print the label when the link has never been clicked - before (i.e. the link has not been @e visited) and the mouse is not over the control. + before (i.e.\ the link has not been @e visited) and the mouse is not over the control. */ virtual wxColour GetNormalColour() const; @@ -165,7 +165,7 @@ public: /** Returns the colour used to print the label when the mouse is not over the - control and the link has already been clicked before (i.e. the link has + control and the link has already been clicked before (i.e.\ the link has been @e visited). */ virtual wxColour GetVisitedColour() const; @@ -178,7 +178,7 @@ public: /** Sets the colour used to print the label when the link has never been clicked before - (i.e. the link has not been @e visited) and the mouse is not over the control. + (i.e.\ the link has not been @e visited) and the mouse is not over the control. */ virtual void SetNormalColour(const wxColour& colour); @@ -194,7 +194,7 @@ public: /** Sets the colour used to print the label when the mouse is not over the control - and the link has already been clicked before (i.e. the link has been @e visited). + and the link has already been clicked before (i.e.\ the link has been @e visited). */ virtual void SetVisitedColour(const wxColour& colour); };