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

@@ -27,8 +27,8 @@
@category{FIXME}
@seealso
@ref overview_wxfontencodingoverview "Font encoding overview", @ref
overview_samplefont "Font sample", wxFont, wxFontMapper
@ref overview_wxfontencodingoverview, @ref overview_samplefont "Font sample",
wxFont, wxFontMapper
*/
class wxFontEnumerator
{
@@ -36,20 +36,19 @@ public:
/**
Call OnFontEncoding() for each
encoding supported by the given font - or for each encoding supported by at
least some font if @e font is not specified.
least some font if @a font is not specified.
*/
virtual bool EnumerateEncodings(const wxString& font = "");
/**
Call OnFacename() for each font which
supports given encoding (only if it is not wxFONTENCODING_SYSTEM) and is of
fixed width (if @e fixedWidthOnly is @true).
fixed width (if @a fixedWidthOnly is @true).
Calling this function with default arguments will result in enumerating all
fonts available on the system.
*/
virtual bool EnumerateFacenames(wxFontEncoding encoding = wxFONTENCODING_SYSTEM,
bool fixedWidthOnly = @false);
bool fixedWidthOnly = false);
/**
Return array of strings containing all encodings found by
@@ -62,14 +61,14 @@ public:
EnumerateFacenames().
*/
static wxArrayString GetFacenames(wxFontEncoding encoding = wxFONTENCODING_SYSTEM,
bool fixedWidthOnly = @false);
bool fixedWidthOnly = false);
/**
Returns @true if the given string is valid face name, i.e. it's the face name
of an installed
font and it can safely be used with wxFont::SetFaceName.
*/
static bool IsValidFacename(const wxString & facename);
static bool IsValidFacename(const wxString& facename);
/**
Called by EnumerateFacenames() for