From 45a591fabafd3be035317dc4ce37be226e1efb46 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sat, 30 Aug 2008 23:58:45 +0000 Subject: [PATCH] more Doxygen warnings corrections and fixes from Tim S git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55386 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/combo.h | 4 +- interface/wx/font.h | 412 +++++++++------------------------ interface/wx/generic/helpext.h | 20 +- 3 files changed, 117 insertions(+), 319 deletions(-) diff --git a/interface/wx/combo.h b/interface/wx/combo.h index f6968fb9a1..66e1678ba6 100644 --- a/interface/wx/combo.h +++ b/interface/wx/combo.h @@ -49,7 +49,7 @@ public: Preferred minimum width. @param prefHeight Preferred height. May be -1 to indicate no preference. - @param maxWidth + @param maxHeight Max height for window, as limited by screen size. @remarks This function is called each time popup is about to be shown. @@ -584,7 +584,7 @@ public: @param text The text to insert. */ - virtual void Replace(long from, long to, const wxString& value); + virtual void Replace(long from, long to, const wxString& text); /** Sets custom dropdown button graphics. diff --git a/interface/wx/font.h b/interface/wx/font.h index affba68a98..6668de53da 100644 --- a/interface/wx/font.h +++ b/interface/wx/font.h @@ -37,11 +37,82 @@ class wxFont : public wxGDIObject { public: //@{ + /** + Creates a font object. + */ + wxFont(); + + /** + Creates a font object with the specified font. + + @param font + font object. + */ + wxFont(const wxFont& font); + /** Creates a font object with the specified attributes. @param pointSize Size in points. + @param family + Font family, a generic way of referring to fonts without specifying actual + facename. One of: + + + + + + + + +
wxFONTFAMILY_DEFAULTChooses a default font.
wxFONTFAMILY_DECORATIVEA decorative font.
wxFONTFAMILY_ROMANA formal, serif font.
wxFONTFAMILY_SCRIPTA handwriting font.
wxFONTFAMILY_SWISSA sans-serif font.
wxFONTFAMILY_MODERNA fixed pitch font.
wxFONTFAMILY_TELETYPEA teletype font.
+ @param style + One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC. + @param weight + Font weight, sometimes also referred to as font boldness. One of: + + + + +
wxFONTWEIGHT_NORMALNormal font.
wxFONTWEIGHT_LIGHTLight font.
wxFONTWEIGHT_BOLDBold font.
+ @param underline + The value can be @true or @false. At present this has an effect on Windows + and Motif 2.x only. + @param faceName + An optional string specifying the actual typeface to be used. If it is an + empty string, + a default typeface will be chosen based on the family. + @param encoding + An encoding which may be one of + + + + + + +
wxFONTENCODING_SYSTEMDefault system encoding.
wxFONTENCODING_DEFAULT + Default application encoding: this + is the encoding set by calls to + SetDefaultEncoding and which may be set to, + say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the + default application encoding is the same as default system encoding.
wxFONTENCODING_ISO8859_1...15ISO8859 encodings.
wxFONTENCODING_KOI8The standard Russian encoding for Internet.
wxFONTENCODING_CP1250...1252Windows encodings similar to ISO8859 (but not identical).
+ + If the specified encoding isn't available, no font is created + (see also font encoding overview). + + @remarks If the desired font does not exist, the closest match will be + chosen. Under Windows, only scalable TrueType fonts are + used. + */ + wxFont(int pointSize, wxFontFamily family, int style, + wxFontWeight weight, + const bool underline = false, + const wxString& faceName = "", + wxFontEncoding encoding = wxFONTENCODING_DEFAULT); + /** + Creates a font object with the specified attributes. + @param pixelSize Size in pixels: this is directly supported only under MSW currently where this constructor can be used directly, under other @@ -51,124 +122,24 @@ public: @param family Font family, a generic way of referring to fonts without specifying actual facename. One of: - - - - - - - - wxFONTFAMILY_DEFAULT - - - - - Chooses a default font. - - - - - - wxFONTFAMILY_DECORATIVE - - - - - A decorative font. - - - - - - wxFONTFAMILY_ROMAN - - - - - A formal, serif font. - - - - - - wxFONTFAMILY_SCRIPT - - - - - A handwriting font. - - - - - - wxFONTFAMILY_SWISS - - - - - A sans-serif font. - - - - - - wxFONTFAMILY_MODERN - - - - - A fixed pitch font. - - - - - - wxFONTFAMILY_TELETYPE - - - - - A teletype font. + + + + + + + + +
wxFONTFAMILY_DEFAULTChooses a default font.
wxFONTFAMILY_DECORATIVEA decorative font.
wxFONTFAMILY_ROMANA formal, serif font.
wxFONTFAMILY_SCRIPTA handwriting font.
wxFONTFAMILY_SWISSA sans-serif font.
wxFONTFAMILY_MODERNA fixed pitch font.
wxFONTFAMILY_TELETYPEA teletype font.
@param style One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC. @param weight Font weight, sometimes also referred to as font boldness. One of: - - - - - - - - wxFONTWEIGHT_NORMAL - - - - - Normal font. - - - - - - wxFONTWEIGHT_LIGHT - - - - - Light font. - - - - - - wxFONTWEIGHT_BOLD - - - - - Bold font. + + + + +
wxFONTWEIGHT_NORMALNormal font.
wxFONTWEIGHT_LIGHTLight font.
wxFONTWEIGHT_BOLDBold font.
@param underline The value can be @true or @false. At present this has an effect on Windows and Motif 2.x only. @@ -178,71 +149,18 @@ public: a default typeface will be chosen based on the family. @param encoding An encoding which may be one of - - - - - - - - wxFONTENCODING_SYSTEM - - - - - Default system encoding. - - - - - - wxFONTENCODING_DEFAULT - - - - - Default application encoding: this - is the encoding set by calls to - SetDefaultEncoding and which may be set to, - say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the - default application encoding is the same as default system encoding. - - - - - - wxFONTENCODING_ISO8859_1...15 - - - - - ISO8859 encodings. - - - - - - wxFONTENCODING_KOI8 - - - - - The standard Russian encoding for Internet. - - - - - - wxFONTENCODING_CP1250...1252 - - - - - Windows encodings similar to ISO8859 (but not identical). - - - - + + + + + + +
wxFONTENCODING_SYSTEMDefault system encoding.
wxFONTENCODING_DEFAULT + Default application encoding: this + is the encoding set by calls to + SetDefaultEncoding and which may be set to, + say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the + default application encoding is the same as default system encoding.
wxFONTENCODING_ISO8859_1...15ISO8859 encodings.
wxFONTENCODING_KOI8The standard Russian encoding for Internet.
wxFONTENCODING_CP1250...1252Windows encodings similar to ISO8859 (but not identical).
If the specified encoding isn't available, no font is created (see also font encoding overview). @@ -251,13 +169,6 @@ public: chosen. Under Windows, only scalable TrueType fonts are used. */ - wxFont(); - wxFont(const wxFont& font); - wxFont(int pointSize, wxFontFamily family, int style, - wxFontWeight weight, - const bool underline = false, - const wxString& faceName = "", - wxFontEncoding encoding = wxFONTENCODING_DEFAULT); wxFont(const wxSize& pixelSize, wxFontFamily family, int style, wxFontWeight weight, const bool underline = false, @@ -424,85 +335,14 @@ public: @param family One of: - - - - - - - - wxFONTFAMILY_DEFAULT - - - - - Chooses a default font. - - - - - - wxFONTFAMILY_DECORATIVE - - - - - A decorative font. - - - - - - wxFONTFAMILY_ROMAN - - - - - A formal, serif font. - - - - - - wxFONTFAMILY_SCRIPT - - - - - A handwriting font. - - - - - - wxFONTFAMILY_SWISS - - - - - A sans-serif font. - - - - - - wxFONTFAMILY_MODERN - - - - - A fixed pitch font. - - - - - - wxFONTFAMILY_TELETYPE - - - - - A teletype font. + + + + + + + + @see GetFamily(), SetFaceName() */ @@ -576,7 +416,7 @@ public: /** Sets underlining. - @param underlining + @param underlined @true to underline, @false otherwise. @see GetUnderlined() @@ -588,41 +428,11 @@ public: @param weight One of: - - - - - - - - wxFONTWEIGHT_NORMAL - - - - - Normal font. - - - - - - wxFONTWEIGHT_LIGHT - - - - - Light font. - - - - - - wxFONTWEIGHT_BOLD - - - - - Bold font. +
wxFONTFAMILY_DEFAULTChooses a default font.
wxFONTFAMILY_DECORATIVEA decorative font.
wxFONTFAMILY_ROMANA formal, serif font.
wxFONTFAMILY_SCRIPTA handwriting font.
wxFONTFAMILY_SWISSA sans-serif font.
wxFONTFAMILY_MODERNA fixed pitch font.
wxFONTFAMILY_TELETYPEA teletype font.
+ + + +
wxFONTWEIGHT_NORMALNormal font.
wxFONTWEIGHT_LIGHTLight font.
wxFONTWEIGHT_BOLDBold font.
@see GetWeight() */ diff --git a/interface/wx/generic/helpext.h b/interface/wx/generic/helpext.h index 72b08a5121..d552ac43e9 100644 --- a/interface/wx/generic/helpext.h +++ b/interface/wx/generic/helpext.h @@ -52,22 +52,6 @@ public: virtual void SetViewer(const wxString& viewer = wxEmptyString, long flags = wxHELP_NETSCAPE); - /** - This must be called to tell the controller where to find the - documentation. - If a locale is set, look in file/localename, i.e. - If passed "/usr/local/myapp/help" and the current wxLocale is - set to be "de", then look in "/usr/local/myapp/help/de/" - first and fall back to "/usr/local/myapp/help" if that - doesn't exist. - - @param file - NOT a filename, but a directory name. - - @return @true on success - */ - virtual bool Initialize(const wxString& dir, int server); - /** This must be called to tell the controller where to find the documentation. @@ -128,6 +112,10 @@ public: @param k string to search for, empty string will list all entries + + @param mode + optional parameter allows the search the index (wxHELP_SEARCH_INDEX) + but this currently only supported by the wxHtmlHelpController. @return @true on success */ -- 2.45.2