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

42
interface/html/htmltag.h
View File

@@ -24,13 +24,12 @@ public:
yourself. Feel free to ignore the constructor parameters.
Have a look at src/html/htmlpars.cpp if you're interested in creating it.
*/
wxHtmlTag(wxHtmlTag * parent, const wxString& source, int pos,
wxHtmlTag(wxHtmlTag* parent, const wxString& source, int pos,
int end_pos, wxHtmlTagsCache* cache,
wxHtmlEntitiesParser * entParser);
wxHtmlEntitiesParser* entParser);
/**
Returns a string containing all parameters.
Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
tag.GetAllParams() would return @c SIZE=+2 COLOR="#000000".
*/
@@ -69,35 +68,32 @@ public:
parameter exists or not (use wxHtmlTag::HasParam) first.
@param par
The parameter's name.
The parameter's name.
@param with_quotes
@true if you want to get quotes as well. See example.
@true if you want to get quotes as well. See example.
*/
wxString GetParam(const wxString& par, bool with_quotes = @false);
wxString GetParam(const wxString& par, bool with_quotes = false);
/**
Interprets tag parameter @e par as colour specification and saves its value
Interprets tag parameter @a par as colour specification and saves its value
into wxColour variable pointed by @e clr.
Returns @true on success and @false if @e par is not colour specification or
Returns @true on success and @false if @a par is not colour specification or
if the tag has no such parameter.
*/
bool GetParamAsColour(const wxString& par, wxColour * clr);
bool GetParamAsColour(const wxString& par, wxColour* clr);
/**
Interprets tag parameter @e par as an integer and saves its value
Interprets tag parameter @a par as an integer and saves its value
into int variable pointed by @e value.
Returns @true on success and @false if @e par is not an integer or
Returns @true on success and @false if @a par is not an integer or
if the tag has no such parameter.
*/
bool GetParamAsInt(const wxString& par, int * value);
bool GetParamAsInt(const wxString& par, int* value);
/**
Returns @true if this tag is paired with ending tag, @false otherwise.
See the example of HTML document:
In this example tags HTML and BODY have ending tags, first P and BR
doesn't have ending tag while the second P has. The third P tag (which
is ending itself) of course doesn't have ending tag.
@@ -110,7 +106,7 @@ public:
"SIZE" and "COLOR".
@param par
the parameter you're looking for.
the parameter you're looking for.
*/
bool HasParam(const wxString& par);
@@ -122,14 +118,12 @@ public:
in @e format).
@param par
The name of the tag you want to query
The name of the tag you want to query
@param format
scanf()-like format string.
scanf()-like format string.
@param value
pointer to a variable to store the value in
pointer to a variable to store the value in
*/
wxString ScanParam(const wxString& par, const wxChar * format,
void * value);
wxString ScanParam(const wxString& par, const wxChar* format,
void* value);
};