fix miscellaneous Doxygen 1.6.1 warnings

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62958 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2009-12-20 15:07:08 +00:00
parent 69aa257b83
commit 163bd4f700
11 changed files with 40 additions and 40 deletions

View File

@@ -40,7 +40,6 @@ public:
*/ */
wxChoice(); wxChoice();
//@{
/** /**
Constructor, creating and showing a choice. Constructor, creating and showing a choice.
@@ -127,7 +126,6 @@ public:
long style = 0, long style = 0,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxChoiceNameStr ); const wxString& name = wxChoiceNameStr );
//@}
/** /**
Destructor, destroying the choice item. Destructor, destroying the choice item.

View File

@@ -9,8 +9,8 @@
/** /**
@class wxClientDataContainer @class wxClientDataContainer
This class is a mixin that provides storage and management of "client This class is a mixin that provides storage and management of "client data".
data." This data can either be of type void - in which case the 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 @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 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 the memory itself later. Note that you @e must not assign both void data

View File

@@ -83,7 +83,6 @@ public:
*/ */
wxComboBox(); wxComboBox();
//@{
/** /**
Constructor, creating and showing a combobox. Constructor, creating and showing a combobox.
@@ -174,7 +173,6 @@ public:
long style = 0, long style = 0,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxComboBoxNameStr); const wxString& name = wxComboBoxNameStr);
//@}
/** /**
Destructor, destroying the combobox. Destructor, destroying the combobox.

View File

@@ -784,7 +784,7 @@ class wxGridColumnHeaderRenderer : public wxGridHeaderLabelsRenderer
@since 2.9.1 @since 2.9.1
*/ */
class wxGridRowHeaderRendererDefault : public wxGridRowHeaderRendererDefault class wxGridRowHeaderRendererDefault : public wxGridRowHeaderRenderer
{ {
public: public:
/// Implement border drawing for the row labels. /// Implement border drawing for the row labels.

View File

@@ -73,7 +73,7 @@ public:
/** /**
Returns tag's name. The name is always in uppercase and it doesn't contain Returns tag's name. The name is always in uppercase and it doesn't contain
" or '/' characters. (So the name of \<FONT SIZE=+2\> tag is "FONT" &quot; or '/' characters. (So the name of \<FONT SIZE=+2\> tag is "FONT"
and name of \</table\> is "TABLE"). and name of \</table\> is "TABLE").
*/ */
wxString GetName() const; wxString GetName() const;

View File

@@ -31,7 +31,7 @@
(although this is the most common case) -- it can be any value which can (although this is the most common case) -- it can be any value which can
be used to uniquely identify an item. be used to uniquely identify an item.
@library{core} @library{wxcore}
@category{events} @category{events}
*/ */
class wxMouseEventsManager : public wxEvtHandler class wxMouseEventsManager : public wxEvtHandler

View File

@@ -68,7 +68,6 @@ public:
*/ */
wxOwnerDrawnComboBox(); wxOwnerDrawnComboBox();
//@{
/** /**
Constructor, creating and showing a owner-drawn combobox. Constructor, creating and showing a owner-drawn combobox.
@@ -138,7 +137,6 @@ public:
long style = 0, long style = 0,
const wxValidator& validator = wxDefaultValidator, const wxValidator& validator = wxDefaultValidator,
const wxString& name = "comboBox"); const wxString& name = "comboBox");
//@}
/** /**
Destructor, destroying the owner-drawn combobox. Destructor, destroying the owner-drawn combobox.

View File

@@ -89,10 +89,15 @@ public:
const wxSize& size = wxDefaultSize, long style = 0, const wxSize& size = wxDefaultSize, long style = 0,
const wxString& name = wxStaticTextNameStr); const wxString& name = wxStaticTextNameStr);
// NB: when writing docs for the following function remember that Doxygen
// will always expand HTML entities (e.g. &quot;) and thus we need to
// write e.g. "&amp;lt;" to have in the output the "&lt;" string.
/** /**
Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for Escapes all the symbols of @a str that have a special meaning (<tt><>&quot;'&</tt>) for
wxStaticText objects with the @c wxST_MARKUP style. wxStaticText objects with the @c wxST_MARKUP style.
Those symbols are replaced the corresponding entities (&lt; &gt; &quot; &apos; &amp;).
Those symbols are replaced the corresponding entities
(&amp;lt; &amp;gt; &amp;quot; &amp;apos; &amp;amp;).
*/ */
static wxString EscapeMarkup(const wxString& str); static wxString EscapeMarkup(const wxString& str);

View File

@@ -20,40 +20,41 @@
Here is an example function using this class which inserts hard line breaks 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: into a string of text at the positions where it would be wrapped:
@code @code
wxString WrapText(wxWindow *win, const wxString& text, int widthMax) wxString WrapText(wxWindow *win, const wxString& text, int widthMax)
{
class HardBreakWrapper : public wxTextWrapper
{ {
public: class HardBreakWrapper : public wxTextWrapper
HardBreakWrapper(wxWindow *win, const wxString& text, int widthMax)
{ {
Wrap(win, text, widthMax); public:
} HardBreakWrapper(wxWindow *win, const wxString& text, int widthMax)
{
Wrap(win, text, widthMax);
}
wxString const& GetWrapped() const { return m_wrapped; } wxString const& GetWrapped() const { return m_wrapped; }
protected: protected:
virtual void OnOutputLine(const wxString& line) virtual void OnOutputLine(const wxString& line)
{ {
m_wrapped += line; m_wrapped += line;
} }
virtual void OnNewLine() virtual void OnNewLine()
{ {
m_wrapped += '\n'; m_wrapped += '\n';
} }
private: private:
wxString m_wrapped; wxString m_wrapped;
}; };
HardBreakWrapper wrapper(win, text, widthMax); HardBreakWrapper wrapper(win, text, widthMax);
return wrapper.GetWrapped(); return wrapper.GetWrapped();
} }
@endcode @endcode
@library{none} @nolibrary
@category{gdi} @category{gdi}
*/ */
class wxTextWrapper class wxTextWrapper

View File

@@ -28,8 +28,8 @@ enum wxStringTokenizerMode
/** /**
In this mode, the empty tokens in the middle of the string will be returned, 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 i.e. @c "a::b:" will be tokenized in three tokens @c 'a', @c '' and @c 'b'.
that all trailing delimiters are ignored in this mode, not just the last one, 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. i.e. a string @c "a::b::" would still result in the same set of tokens.
*/ */
wxTOKEN_RET_EMPTY, wxTOKEN_RET_EMPTY,

View File

@@ -257,7 +257,7 @@ public:
The tool to be added. The tool to be added.
@remarks After you have added tools to a toolbar, you must call @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(), @see AddSeparator(), AddCheckTool(), AddRadioTool(),
InsertTool(), DeleteTool(), Realize(), SetDropdownMenu() InsertTool(), DeleteTool(), Realize(), SetDropdownMenu()