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

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

View File

@@ -32,14 +32,13 @@ public:
Constructor.
@param currentTip
The starting tip index.
The starting tip index.
*/
wxTipProvider(size_t currentTip);
/**
Returns the index of the current tip (i.e. the one which would be returned by
GetTip).
The program usually remembers the value returned by this function after calling
wxShowTip. Note that it is not the same as the value which
was passed to wxShowTip + 1 because the user might have pressed the "Next"
@@ -75,14 +74,13 @@ public:
used with wxShowTip.
@param filename
The name of the file containing the tips, one per line
The name of the file containing the tips, one per line
@param currentTip
The index of the first tip to show - normally this index
is remembered between the 2 program runs.
The index of the first tip to show - normally this index
is remembered between the 2 program runs.
@sa @ref overview_tipsoverview "Tips overview"
@see @ref overview_tipsoverview "Tips overview"
*/
wxTipProvider * wxCreateFileTipProvider(const wxString& filename,
size_t currentTip);
wxTipProvider* wxCreateFileTipProvider(const wxString& filename,
size_t currentTip);