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

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
interface/clipboard.h
View File

@@ -7,9 +7,9 @@
/////////////////////////////////////////////////////////////////////////////
/**
Gets the name of a registered clipboard format, and puts it into the buffer @e
Gets the name of a registered clipboard format, and puts it into the buffer @a
formatName which is of maximum
length @e maxCount. @e dataFormat must not specify a predefined clipboard
length @e maxCount. @a dataFormat must not specify a predefined clipboard
format.
*/
bool wxGetClipboardFormatName(int dataFormat,
@@ -19,16 +19,13 @@ bool wxGetClipboardFormatName(int dataFormat,
/**
Gets data from the clipboard.
@e dataFormat may be one of:
@a dataFormat may be one of:
wxCF_TEXT or wxCF_OEMTEXT: returns a pointer to new memory containing a
null-terminated text string.
wxCF_BITMAP: returns a new wxBitmap.
The clipboard must have previously been opened for this call to succeed.
*/
wxObject * wxGetClipboardData(int dataFormat);
wxObject* wxGetClipboardData(int dataFormat);
/**
Returns @true if the given data format is available on the clipboard.
@@ -65,15 +62,12 @@ bool wxCloseClipboard();
to the clipboard. Each call to this function specifies a known
available format; the function returns the format that appears next in
the list.
@e dataFormat specifies a known format. If this parameter is zero,
@a dataFormat specifies a known format. If this parameter is zero,
the function returns the first format in the list.
The return value specifies the next known clipboard data format if the
function is successful. It is zero if the @e dataFormat parameter specifies
function is successful. It is zero if the @a dataFormat parameter specifies
the last format in the list of available formats, or if the clipboard
is not open.
Before it enumerates the formats function, an application must open the
clipboard by using the
wxOpenClipboard function.