From 163bd4f700765483562e95b19670c699d0821283 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sun, 20 Dec 2009 15:07:08 +0000 Subject: [PATCH] fix miscellaneous Doxygen 1.6.1 warnings git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62958 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/choice.h | 2 -- interface/wx/clntdata.h | 4 +-- interface/wx/combobox.h | 2 -- interface/wx/grid.h | 2 +- interface/wx/html/htmltag.h | 2 +- interface/wx/mousemanager.h | 2 +- interface/wx/odcombo.h | 2 -- interface/wx/stattext.h | 9 ++++-- interface/wx/textwrapper.h | 59 +++++++++++++++++++------------------ interface/wx/tokenzr.h | 4 +-- interface/wx/toolbar.h | 2 +- 11 files changed, 45 insertions(+), 45 deletions(-) diff --git a/interface/wx/choice.h b/interface/wx/choice.h index 975052193e..20ec50bc12 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -40,7 +40,6 @@ public: */ wxChoice(); - //@{ /** Constructor, creating and showing a choice. @@ -127,7 +126,6 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxChoiceNameStr ); - //@} /** Destructor, destroying the choice item. diff --git a/interface/wx/clntdata.h b/interface/wx/clntdata.h index dea129e018..77f3cbe1c9 100644 --- a/interface/wx/clntdata.h +++ b/interface/wx/clntdata.h @@ -9,8 +9,8 @@ /** @class wxClientDataContainer - This class is a mixin that provides storage and management of "client - data." This data can either be of type void - in which case the data + This class is a mixin that provides storage and management of "client data". + This data can either be of type void - in which case the data @e container does not take care of freeing the data again or it is of type wxClientData or its derivatives. In that case the container will free the memory itself later. Note that you @e must not assign both void data diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index d8f8392bb1..67029f392b 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -83,7 +83,6 @@ public: */ wxComboBox(); - //@{ /** Constructor, creating and showing a combobox. @@ -174,7 +173,6 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxComboBoxNameStr); - //@} /** Destructor, destroying the combobox. diff --git a/interface/wx/grid.h b/interface/wx/grid.h index 65ae9e76ce..136852d45e 100644 --- a/interface/wx/grid.h +++ b/interface/wx/grid.h @@ -784,7 +784,7 @@ class wxGridColumnHeaderRenderer : public wxGridHeaderLabelsRenderer @since 2.9.1 */ -class wxGridRowHeaderRendererDefault : public wxGridRowHeaderRendererDefault +class wxGridRowHeaderRendererDefault : public wxGridRowHeaderRenderer { public: /// Implement border drawing for the row labels. diff --git a/interface/wx/html/htmltag.h b/interface/wx/html/htmltag.h index 10136ab202..3745c06d8b 100644 --- a/interface/wx/html/htmltag.h +++ b/interface/wx/html/htmltag.h @@ -73,7 +73,7 @@ public: /** Returns tag's name. The name is always in uppercase and it doesn't contain - " or '/' characters. (So the name of \ tag is "FONT" + " or '/' characters. (So the name of \ tag is "FONT" and name of \ is "TABLE"). */ wxString GetName() const; diff --git a/interface/wx/mousemanager.h b/interface/wx/mousemanager.h index 154f390643..bebd92691f 100644 --- a/interface/wx/mousemanager.h +++ b/interface/wx/mousemanager.h @@ -31,7 +31,7 @@ (although this is the most common case) -- it can be any value which can be used to uniquely identify an item. - @library{core} + @library{wxcore} @category{events} */ class wxMouseEventsManager : public wxEvtHandler diff --git a/interface/wx/odcombo.h b/interface/wx/odcombo.h index 92c516b9e2..7152e2f28a 100644 --- a/interface/wx/odcombo.h +++ b/interface/wx/odcombo.h @@ -68,7 +68,6 @@ public: */ wxOwnerDrawnComboBox(); - //@{ /** Constructor, creating and showing a owner-drawn combobox. @@ -138,7 +137,6 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "comboBox"); - //@} /** Destructor, destroying the owner-drawn combobox. diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h index 613d99661a..4e297aabc5 100644 --- a/interface/wx/stattext.h +++ b/interface/wx/stattext.h @@ -89,10 +89,15 @@ public: const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = wxStaticTextNameStr); + // NB: when writing docs for the following function remember that Doxygen + // will always expand HTML entities (e.g. ") and thus we need to + // write e.g. "&lt;" to have in the output the "<" string. /** - Escapes all the symbols of @a str that have a special meaning (<>"'&) for + Escapes all the symbols of @a str that have a special meaning (<>"'&) for wxStaticText objects with the @c wxST_MARKUP style. - Those symbols are replaced the corresponding entities (< > " ' &). + + Those symbols are replaced the corresponding entities + (&lt; &gt; &quot; &apos; &amp;). */ static wxString EscapeMarkup(const wxString& str); diff --git a/interface/wx/textwrapper.h b/interface/wx/textwrapper.h index dd830ed3e3..c82b4ff1a2 100644 --- a/interface/wx/textwrapper.h +++ b/interface/wx/textwrapper.h @@ -20,40 +20,41 @@ Here is an example function using this class which inserts hard line breaks into a string of text at the positions where it would be wrapped: + @code -wxString WrapText(wxWindow *win, const wxString& text, int widthMax) -{ - class HardBreakWrapper : public wxTextWrapper + wxString WrapText(wxWindow *win, const wxString& text, int widthMax) { - public: - HardBreakWrapper(wxWindow *win, const wxString& text, int widthMax) - { - Wrap(win, text, widthMax); - } - - wxString const& GetWrapped() const { return m_wrapped; } - - protected: - virtual void OnOutputLine(const wxString& line) + class HardBreakWrapper : public wxTextWrapper { - m_wrapped += line; - } - - virtual void OnNewLine() - { - m_wrapped += '\n'; - } - - private: - wxString m_wrapped; - }; - - HardBreakWrapper wrapper(win, text, widthMax); - return wrapper.GetWrapped(); -} + public: + HardBreakWrapper(wxWindow *win, const wxString& text, int widthMax) + { + Wrap(win, text, widthMax); + } + + wxString const& GetWrapped() const { return m_wrapped; } + + protected: + virtual void OnOutputLine(const wxString& line) + { + m_wrapped += line; + } + + virtual void OnNewLine() + { + m_wrapped += '\n'; + } + + private: + wxString m_wrapped; + }; + + HardBreakWrapper wrapper(win, text, widthMax); + return wrapper.GetWrapped(); + } @endcode - @library{none} + @nolibrary @category{gdi} */ class wxTextWrapper diff --git a/interface/wx/tokenzr.h b/interface/wx/tokenzr.h index a609e1557d..ac7dcecefc 100644 --- a/interface/wx/tokenzr.h +++ b/interface/wx/tokenzr.h @@ -28,8 +28,8 @@ enum wxStringTokenizerMode /** In this mode, the empty tokens in the middle of the string will be returned, - i.e. @c "a::b:" will be tokenized in three tokens @c 'a', " and @c 'b'. Notice - that all trailing delimiters are ignored in this mode, not just the last one, + i.e. @c "a::b:" will be tokenized in three tokens @c 'a', @c '' and @c 'b'. + Notice that all trailing delimiters are ignored in this mode, not just the last one, i.e. a string @c "a::b::" would still result in the same set of tokens. */ wxTOKEN_RET_EMPTY, diff --git a/interface/wx/toolbar.h b/interface/wx/toolbar.h index 1ff4d008b9..95b3dbf776 100644 --- a/interface/wx/toolbar.h +++ b/interface/wx/toolbar.h @@ -257,7 +257,7 @@ public: The tool to be added. @remarks After you have added tools to a toolbar, you must call - Realize() in order to have the tools appear. + Realize() in order to have the tools appear. @see AddSeparator(), AddCheckTool(), AddRadioTool(), InsertTool(), DeleteTool(), Realize(), SetDropdownMenu() -- 2.47.2