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

Fix misc documentation warnings (patch by Tim Stahlhut).

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55304 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-08-27 04:20:07 +00:00
parent f3d7473941
commit 4050e98de9
6 changed files with 25 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
interface/wx/dcbuffer.h
View File

@@ -50,7 +50,7 @@ public:
//@{
/**
Creates a buffer for the provided @dc. Init() must not be called when
Creates a buffer for the provided @a dc. Init() must not be called when
using this constructor.
@param dc
@@ -60,6 +60,21 @@ public:
@param area
The size of the bitmap to be used for buffering (this bitmap is
created internally when it is not given explicitly).
@param style
wxBUFFER_CLIENT_AREA to indicate that just the client area of the
window is buffered, or wxBUFFER_VIRTUAL_AREA to indicate that the
buffer bitmap covers the virtual area.
*/
wxBufferedDC(wxDC* dc, const wxSize& area,
int style = wxBUFFER_CLIENT_AREA);
/**
Creates a buffer for the provided dc. Init() must not be called when
using this constructor.
@param dc
The underlying DC: everything drawn to this object will be flushed
to this DC when this object is destroyed. You may pass @NULL in
order to just initialize the buffer, and not flush it.
@param buffer
Explicitly provided bitmap to be used for buffering: this is the
most efficient solution as the bitmap doesn't have to be recreated
@@ -71,8 +86,6 @@ public:
window is buffered, or wxBUFFER_VIRTUAL_AREA to indicate that the
buffer bitmap covers the virtual area.
*/
wxBufferedDC(wxDC* dc, const wxSize& area,
int style = wxBUFFER_CLIENT_AREA);
wxBufferedDC(wxDC* dc, wxBitmap& buffer,
int style = wxBUFFER_CLIENT_AREA);
//@}

8
interface/wx/defs.h
View File

@@ -107,13 +107,13 @@ enum wxPaperSize
wxPAPER_10X11, ///< 10 x 11 in
wxPAPER_15X11, ///< 15 x 11 in
wxPAPER_ENV_INVITE, ///< Envelope Invite 220 x 220 mm
wxPAPER_LETTER_EXTRA, ///< Letter Extra 9 \275 x 12 in
wxPAPER_LEGAL_EXTRA, ///< Legal Extra 9 \275 x 15 in
wxPAPER_LETTER_EXTRA, ///< Letter Extra 9.5 x 12 in
wxPAPER_LEGAL_EXTRA, ///< Legal Extra 9.5 x 15 in
wxPAPER_TABLOID_EXTRA, ///< Tabloid Extra 11.69 x 18 in
wxPAPER_A4_EXTRA, ///< A4 Extra 9.27 x 12.69 in
wxPAPER_LETTER_TRANSVERSE, ///< Letter Transverse 8 \275 x 11 in
wxPAPER_LETTER_TRANSVERSE, ///< Letter Transverse 8.5 x 11 in
wxPAPER_A4_TRANSVERSE, ///< A4 Transverse 210 x 297 mm
wxPAPER_LETTER_EXTRA_TRANSVERSE, ///< Letter Extra Transverse 9\275 x 12 in
wxPAPER_LETTER_EXTRA_TRANSVERSE, ///< Letter Extra Transverse 9.5 x 12 in
wxPAPER_A_PLUS, ///< SuperA/SuperA/A4 227 x 356 mm
wxPAPER_B_PLUS, ///< SuperB/SuperB/A3 305 x 487 mm
wxPAPER_LETTER_PLUS, ///< Letter Plus 8.5 x 12.69 in

2
interface/wx/dynarray.h
View File

@@ -397,7 +397,7 @@ public:
@c T.
This version is used with wxObjArray. The array will take ownership of
the @item, deleting it when the item is deleted from the array. Note
the @a item, deleting it when the item is deleted from the array. Note
that you cannot append more than one pointer as reusing it would lead
to deleting it twice (or more) resulting in a crash.

2
interface/wx/file.h
View File

@@ -325,7 +325,7 @@ public:
/**
Write data to the file (descriptor).
@buffer
@param buffer
Buffer from which to read data
@param count
Number of bytes to write

2
interface/wx/list.h
View File

@@ -93,7 +93,7 @@ public:
wxList<T>();
/**
Constructor which initialized the list with an array of @count elements.
Constructor which initialized the list with an array of @a count elements.
*/
wxList<T>(size_t count, T* elements[]);

4
interface/wx/strconv.h
View File

@@ -113,7 +113,7 @@ public:
Pointer to output buffer of the size of at least @a dstLen or @NULL.
@param dstLen
Maximal number of characters to be written to the output buffer if
@dst is non-@NULL, unused otherwise.
@a dst is non-@NULL, unused otherwise.
@param src
Point to the source string, must not be @NULL.
@param
@@ -140,7 +140,7 @@ public:
Pointer to output buffer of the size of at least @a dstLen or @NULL.
@param dstLen
Maximal number of characters to be written to the output buffer if
@dst is non-@NULL, unused otherwise.
@a dst is non-@NULL, unused otherwise.
@param src
Point to the source string, must not be @NULL.
@param