Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Minor documentation corrections.

Browse Source 
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
This commit is contained in:
Vadim Zeitlin
2014-05-06 18:16:29 +00:00
parent 6fc2e956cf
commit 3f7086de4c
4 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
interface/wx/choice.h
View File

@@ -148,8 +148,8 @@ public:
/** /**
Unlike wxControlWithItems::GetSelection() which only returns the Unlike wxControlWithItems::GetSelection() which only returns the
accepted selection value, i.e. the selection in the control once the accepted selection value (the selection in the control once the
user closes the dropdown list, this function returns the current user closes the dropdown list), this function returns the current
selection. That is, while the dropdown list is shown, it returns the 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 currently selected item in it. When it is not shown, its result is the
same as for the other function. same as for the other function.

2
interface/wx/fontdlg.h
View File

@@ -13,7 +13,7 @@
@library{wxcore} @library{wxcore}
@category{cmndlg} @category{cmndlg}
@see overview_cmndlg_font, wxFontData, wxGetFontFromUser() @see @ref overview_cmndlg_font, wxFontData, wxGetFontFromUser()
*/ */
class wxFontDialog : public wxDialog class wxFontDialog : public wxDialog
{ {

3
interface/wx/hashset.h
View File

@@ -204,7 +204,8 @@ public:
/** /**
If an element with the given key is present, the functions returns If an element with the given key is present, the functions returns
an iterator pointing at that element, otherwise an invalid iterator an iterator pointing at that element, otherwise an invalid iterator
is returned; i.e. is returned.
i.e.
@code @code
hashset.find( non_existent_key ) == hashset.end() hashset.find( non_existent_key ) == hashset.end()
@endcode @endcode

8
interface/wx/hyperlink.h
View File

@@ -148,7 +148,7 @@ public:
/** /**
Returns the colour used to print the label when the link has never been clicked 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; virtual wxColour GetNormalColour() const;
@@ -165,7 +165,7 @@ public:
/** /**
Returns the colour used to print the label when the mouse is not over the 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). been @e visited).
*/ */
virtual wxColour GetVisitedColour() const; 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 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); 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 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); virtual void SetVisitedColour(const wxColour& colour);
}; };