Fix various doxygen issues in the documentation

This commit is contained in:
Artur Wieczorek 2019-10-20 11:52:26 +02:00
parent 8d962b0121
commit 5925893eed
29 changed files with 58 additions and 37 deletions

View File

@ -348,7 +348,7 @@ compilers. See also wxUSE_NO_MANIFEST.}
@itemdef{wxUSE_WINRT, Enable WinRT support.}
@itemdef{wxUSE_WXDIB, Use wxDIB class.}
@itemdef{wxUSE_WINSOCK2, Include @c <winsock2.h> instead of @c <winsock.h>.
Turned on automatically if ::wxUSE_IPV6 is on (this option is new since
Turned on automatically if wxUSE_IPV6 is on (this option is new since
wxWidgets 3.1.3).}
@endDefList

View File

@ -337,7 +337,7 @@ public:
This method writes the serialized data into the passed pane. Pointers to
UI elements are not modified.
@notice This operation also changes the name in the pane information!
@note This operation also changes the name in the pane information!
@sa LoadPerspective
@sa SavePaneInfo().

View File

@ -469,7 +469,7 @@ public:
@since 3.1.0
*/
bool CreateScaled(int logwidth, int logheight, int depth, double logicalScale);
bool CreateScaled(int width, int height, int depth, double logicalScale);
/*
Creates a bitmap from the given data, which can be of arbitrary type.

View File

@ -224,7 +224,7 @@ struct wxCmdLineEntryDesc
class wxCmdLineArg
{
public:
virtual ~wxCmdLineArg() {}
virtual ~wxCmdLineArg();
/**
Returns the command line argument value as a wxDateTime.

View File

@ -32,7 +32,7 @@
class wxCollapsibleHeaderCtrl : public wxControl
{
public:
wxCollapsibleHeaderCtrl() { }
wxCollapsibleHeaderCtrl();
/**
Constructor fully creating the control.

View File

@ -2220,7 +2220,7 @@ public:
class wxDataViewCheckIconTextRenderer : public wxDataViewRenderer
{
public:
static wxString GetDefaultType() { return wxS("wxDataViewCheckIconText"); }
static wxString GetDefaultType();
/**
Create a new renderer.

View File

@ -299,6 +299,7 @@ public:
broken either after a new line or wrapped, at word boundary, if their
width would become bigger than the specified maximal width.
@param message The text to be displayed.
@param widthMax Specifies the text's maximum width (this argument is
available since version 3.1.1, previous versions always behaved as if
the maximal width of -1 was specified).

View File

@ -277,7 +277,7 @@ public:
const wxSize& size = wxDefaultSize,
long style = 0);
virtual ~wxDirFilterListCtrl() {}
virtual ~wxDirFilterListCtrl();
void Init();

View File

@ -832,6 +832,10 @@ public:
If @a attribList is not specified, wxGLAttributes::PlatformDefaults()
is used, plus some other attributes (see below).
@param parent
Pointer to a parent window.
@param id
Window identifier. If -1, will automatically create an identifier.
@param attribList
Array of integers. With this parameter you can set the device
context attributes associated to this window. This array is
@ -850,6 +854,22 @@ public:
WX_GL_DOUBLEBUFFER are used. But notice that if you do specify some
attributes you also need to explicitly include these two default
attributes in the list if you need them.
@param pos
Window position. wxDefaultPosition is (-1, -1) which indicates that
wxWidgets should generate a default position for the window.
@param size
Window size. wxDefaultSize is (-1, -1) which indicates that
wxWidgets should generate a default size for the window. If no
suitable size can be found, the window will be sized to 20x20
pixels so that the window is visible but obviously not correctly
sized.
@param style
Window style.
@param name
Window name.
@param palette
Palette for indexed colour (i.e. non WX_GL_RGBA) mode. Ignored
under most platforms.
*/
wxGLCanvas(wxWindow* parent, wxWindowID id = wxID_ANY,
const int* attribList = NULL,

View File

@ -334,7 +334,7 @@ public:
/**
Default constructor creates an invalid bitmap.
*/
wxGraphicsBitmap() {}
wxGraphicsBitmap();
/**
Return the contents of this bitmap as wxImage.

View File

@ -4365,7 +4365,7 @@ public:
wxGridWindow* CellToGridWindow( int row, int col ) const;
/// @overload
wxGridWindow* CellToGridWindow( const wxGridCellCoords& coords ) const
wxGridWindow* CellToGridWindow( const wxGridCellCoords& coords ) const;
/**
Returns the grid window that includes the input coordinates.

View File

@ -327,7 +327,7 @@ public:
/**
Sets the bitmap type for the handler.
@param mimetype
@param type
The bitmap type.
*/
void SetType(wxBitmapType type);

View File

@ -1659,7 +1659,7 @@ public:
@param parent
Parent window. Must not be @NULL.
@param id
@param winid
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position.

View File

@ -39,7 +39,7 @@
delete the native window when the wxNativeWindow itself is destroyed, you
need to explicitly call Disown(). Otherwise you need to perform the
necessary cleanup in your own code by calling the appropriate
platform-specific function: under MSW, this is @c ::DestroyWindow(), under
platform-specific function: under MSW, this is @c \::DestroyWindow(), under
GTK @c g_object_unref() and under Cocoa -- @c -release:.
See the "native" page of the widgets sample for the examples of using

View File

@ -95,7 +95,7 @@ public:
The preprocessor macro `wxHAS_PREF_EDITOR_APPLY_IMMEDIATELY` is defined
in this case as well.
*/
static bool ShouldApplyChangesImmediately()
static bool ShouldApplyChangesImmediately();
/**
Returns whether the preferences dialog is shown modally.

View File

@ -228,7 +228,7 @@ public:
text constant in order to avoid jarring dialog size changes. You may
also want to make the initial message, specified when creating the
dialog, wide enough to avoid having to resize the dialog later, e.g. by
appending a long string of unbreakable spaces (@c wxString(L'\u00a0',
appending a long string of unbreakable spaces (@c wxString(L'\\u00a0',
100)) to it.
@param value

View File

@ -538,7 +538,7 @@ public:
@param min_width_medium
Requested minimum width of the button text in pixel
if the button is medium size.
@param min_width_medium
@param min_width_large
Requested minimum width of the button text in pixel
if the button is large size.

View File

@ -144,7 +144,7 @@ public:
const wxBitmap& bitmap_disabled = wxNullBitmap,
const wxString& help_string = wxEmptyString,
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
wxObject* clientData = NULL);
wxObject* client_data = NULL);
/**
Add a separator to the tool bar.
@ -249,7 +249,7 @@ public:
const wxBitmap& bitmap_disabled = wxNullBitmap,
const wxString& help_string = wxEmptyString,
wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
wxObject* clientData = NULL);
wxObject* client_data = NULL);
/**
Insert a separator to the tool bar at the specified position.

View File

@ -118,7 +118,7 @@ public:
UTF-8-encoded string, so by default ::wxConvWhateverWorks, which tries
to interpret it in any way not avoiding loss of data, is used. However
if the secrets are only saved by the program itself and are known to be
always encoded in UTF-8, it may be better to pass ::wxConvUTF8 as the
always encoded in UTF-8, it may be better to pass ::wxMBConvUTF8 as the
converter to use.
*/
wxString GetAsString(const wxMBConv& conv = wxConvWhateverWorks) const;

View File

@ -383,7 +383,7 @@ public:
/**
Sets the tick mark frequency and position.
@param n
@param freq
Frequency. For example, if the frequency is set to two, a tick mark is
displayed for every other increment in the slider's range.

View File

@ -53,7 +53,7 @@ public:
/**
Destructor.
*/
virtual ~wxStdInputStreamBuffer() { }
virtual ~wxStdInputStreamBuffer();
};
/**
@ -102,7 +102,7 @@ public:
/**
Destructor.
*/
virtual ~wxStdInputStream() { }
virtual ~wxStdInputStream();
};
/**
@ -147,7 +147,7 @@ public:
/**
Destructor.
*/
virtual ~wxStdOutputStreamBuffer() { }
virtual ~wxStdOutputStreamBuffer();
};
/**
@ -185,5 +185,5 @@ public:
/**
Destructor.
*/
virtual ~wxStdOutputStream() { }
virtual ~wxStdOutputStream();
};

View File

@ -181,8 +181,8 @@ public:
including the terminating @c NUL character.
@return
If @dst is non-@NULL, the number of characters actually written to
it. If @dst is @NULL, the returned value is at least equal to the
If @a dst is non-@NULL, the number of characters actually written to
it. If @a dst is @NULL, the returned value is at least equal to the
number of characters that would have been written out if it were
non-@NULL, but can be larger than it under the platforms using
UTF-16 as @c wchar_t encoding (this allows a useful optimization in

View File

@ -436,7 +436,7 @@ public:
bool GetFontUnderlined() const;
/**
Returns the underline type, which is one of the @wxTextAttrUnderlineType values.
Returns the underline type, which is one of the wxTextAttrUnderlineType values.
@since 3.1.3
*/

View File

@ -16,7 +16,7 @@ wxEventType wxEVT_TOGGLEBUTTON;
Since wxWidgets version 2.9.0 this control emits an update UI event.
You can see wxToggleButton in action in @ref page_samples_controls.
You can see wxToggleButton in action in @ref page_samples_widgets.
@beginEventEmissionTable{wxCommandEvent}
@event{EVT_TOGGLEBUTTON(id, func)}

View File

@ -494,11 +494,11 @@ public:
virtual void OnDelete();
/**
Callback called by Kill() before actually killing the thread.
Callback called by wxThread::Kill() before actually killing the thread.
This function can be overridden by the derived class to perform some
specific task when the thread is terminated. Notice that it will be
executed in the context of the thread that called Kill() and <b>not</b>
executed in the context of the thread that called wxThread::Kill() and <b>not</b>
in this thread's context.
@since 2.9.2
@ -508,8 +508,8 @@ public:
virtual void OnKill();
/**
Callback called by Exit() before actually exiting the thread.
This function will not be called if the thread was @ref Kill() killed.
Callback called by wxThread::Exit() before actually exiting the thread.
This function will not be called if the thread was killed with wxThread::Kill.
This function can be overridden by the derived class to perform some
specific task when the thread is exited. The base class version does

View File

@ -998,6 +998,6 @@ public:
/**
Factory function to create a new separator toolbar tool.
*/
wxToolBarToolBase *CreateSeparator()
wxToolBarToolBase *CreateSeparator();
};

View File

@ -64,7 +64,7 @@ public:
<b>In Unicode build only:</b> The encoding converter used to
convert the bytes in the underlying input stream to characters.
*/
wxTextInputStream(wxInputStream& stream, const wxString& sep = " \t",
wxTextInputStream(wxInputStream& stream, const wxString& sep = " \\ t",
const wxMBConv& conv = wxConvAuto());
/**

View File

@ -691,7 +691,7 @@ enum
wxStrip_Mnemonics = 1,
/**
Strip everything after '\t'.
Strip everything after '\\t'.
This flags removes everything following the last TAB character in the
string, if any.

View File

@ -501,9 +501,9 @@ public:
@param pubid
The public identifier.
*/
wxXmlDoctype(const wxString& rootName = wxString(),
const wxString& systemId = wxString(),
const wxString& publicId = wxString());
wxXmlDoctype(const wxString& name = wxString(),
const wxString& sysid = wxString(),
const wxString& pubid = wxString());
/**
Removes all the DOCTYPE values.