wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

data/lib/wx/doc/gen/font.rb

@@ -206,7 +206,7 @@ module Wx
     # 
     FONTFLAG_UNDERLINED = Wx::FontFlag.new(64)
     
-    # Strike-through style (implemented in MSW, GTK, and {Wx::OSX})
+    # Strike-through style (implemented in MSW, GTK, and wxOSX)
     # 
     FONTFLAG_STRIKETHROUGH = Wx::FontFlag.new(128)
     
@@ -667,9 +667,9 @@ module Wx
     alias_method :base_font, :get_base_font
     
     # Returns the encoding of this font.
-    # Note that under {Wx::GTK} the returned value is always {Wx::FontEncoding::FONTENCODING_UTF8}.
+    # Note that under wxGTK the returned value is always {Wx::FontEncoding::FONTENCODING_UTF8}.
     # @see Wx::Font#set_encoding 
-    # @return [FontEncoding]
+    # @return [Wx::FontEncoding]
     def get_encoding; end
     alias_method :encoding, :get_encoding
     
@@ -685,7 +685,7 @@ module Wx
     # If the current font face name is not recognized by {Wx::Font} or by the underlying system, {Wx::FontFamily::FONTFAMILY_DEFAULT} is returned.
     # Note that currently this function is not very precise and so not particularly useful. Font families mostly make sense only for font creation, see {Wx::Font#set_family}.
     # @see Wx::Font#set_family 
-    # @return [FontFamily]
+    # @return [Wx::FontFamily]
     def get_family; end
     alias_method :family, :get_family
     
@@ -700,7 +700,7 @@ module Wx
     
     # Returns a user-friendly string for this font object.
     # Returned string is always non-empty unless the font is invalid (in which case an assert is triggered).
-    # The string does not encode all {Wx::Font} infos under all platforms; e.g. under {Wx::MSW} the font family is not present in the returned string.
+    # The string does not encode all {Wx::Font} infos under all platforms; e.g. under wxMSW the font family is not present in the returned string.
     # Some examples of the formats of returned strings (which are platform-dependent) are in {Wx::Font#set_native_font_info_user_desc}.
     # @see Wx::Font#set_native_font_info_user_desc
     # @see  Wx::Font#get_native_font_info_desc 
@@ -726,7 +726,7 @@ module Wx
     alias_method :fractional_point_size, :get_fractional_point_size
     
     # Gets the pixel size.
-    # Note that under {Wx::MSW} if you passed to {Wx::Font#set_pixel_size} (or to the ctor) a {Wx::Size} object with a null width value, you'll get a null width in the returned object.
+    # Note that under wxMSW if you passed to {Wx::Font#set_pixel_size} (or to the ctor) a {Wx::Size} object with a null width value, you'll get a null width in the returned object.
     # @see Wx::Font#set_pixel_size 
     # @return [Wx::Size]
     def get_pixel_size; end
@@ -735,26 +735,26 @@ module Wx
     # Gets the font style.
     # See {Wx::FontStyle} for a list of valid styles.
     # @see Wx::Font#set_style 
-    # @return [FontStyle]
+    # @return [Wx::FontStyle]
     def get_style; end
     alias_method :style, :get_style
     
     # Returns true if the font is underlined, false otherwise.
     # 
     # @see Wx::Font#set_underlined 
-    # @return [true,false]
+    # @return [Boolean]
     def get_underlined; end
     
     # Returns true if the font is stricken-through, false otherwise.
     # 
     # @see Wx::Font#set_strikethrough
-    # @return [true,false]
+    # @return [Boolean]
     def get_strikethrough; end
     
     # Gets the font weight.
     # See {Wx::FontWeight} for a list of valid weight identifiers.
     # @see Wx::Font#set_weight 
-    # @return [FontWeight]
+    # @return [Wx::FontWeight]
     def get_weight; end
     alias_method :weight, :get_weight
     
@@ -769,24 +769,24 @@ module Wx
     
     # Returns true if the font is a fixed width (or monospaced) font, false if it is a proportional one or font is invalid.
     # Note that this function under some platforms is different from just testing for the font family being equal to {Wx::FontFamily::FONTFAMILY_TELETYPE} because native platform-specific functions are used for the check (resulting in a more accurate return value).
-    # @return [true,false]
+    # @return [Boolean]
     def is_fixed_width; end
     alias_method :fixed_width?, :is_fixed_width
     
     # Returns true if this object is a valid font, false otherwise.
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
     # Specify the name of a file containing a TrueType font to be made available to the current application.
     # This method can be used to allow this application to use the font from the given file even if it is not globally installed on the system.
-    # Under macOS this method actually doesn't do anything other than check for the existence of the file in the "Fonts" subdirectory of the application bundle "Resources" directory. You are responsible for actually making the font file available in this directory and setting ATSApplicationFontsPath to Fonts value in your Info.plist file. See also Wx::StandardPaths#get_resources_dir.
+    # Under macOS this method actually doesn't do anything other than check for the existence of the file in the "Fonts" subdirectory of the application bundle "Resources" directory. You are responsible for actually making the font file available in this directory and setting ATSApplicationFontsPath to Fonts value in your Info.plist file. See also {Wx::StandardPaths#get_resources_dir}.
     # Under MSW this method must be called before any {Wx::GraphicsContext} objects have been created, otherwise the private font won't be usable from them.
     # Under Unix this method requires Pango 1.38 or later and will return false and log an error message explaining the problem if this requirement is not satisfied either at compile- or run-time.
     # Currently this method is implemented for all major platforms (subject to having Pango 1.38 or later when running configure under Unix) and {Wx::Setup::USE_PRIVATE_FONTS} is always set to 0 under the other platforms, making this function unavailable at compile-time.
     # true if the font was added and can now be used.
     # @param filename [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def self.add_private_font(filename) end
     
     # Returns a bold version of this font.
@@ -824,7 +824,7 @@ module Wx
     def underlined; end
     
     # Returns stricken-through version of this font.
-    # Currently stricken-through fonts are only supported in {Wx::MSW}, {Wx::GTK}, and {Wx::OSX}.
+    # Currently stricken-through fonts are only supported in wxMSW, wxGTK, and wxOSX.
     # @see Wx::Font#make_strikethrough
     # @return [Wx::Font]
     def strikethrough; end
@@ -864,7 +864,7 @@ module Wx
     def make_underlined; end
     
     # Changes this font to be stricken-through.
-    # Currently stricken-through fonts are only supported in {Wx::MSW}, {Wx::GTK}, and {Wx::OSX}.
+    # Currently stricken-through fonts are only supported in wxMSW, wxGTK, and wxOSX.
     # @see Wx::Font#strikethrough
     # @return [Wx::Font]
     def make_strikethrough; end
@@ -888,9 +888,9 @@ module Wx
     def scaled(x) end
     
     # Sets the encoding for this font.
-    # Note that under {Wx::GTK} this function has no effect (because the underlying Pango library always uses {Wx::FontEncoding::FONTENCODING_UTF8}).
+    # Note that under wxGTK this function has no effect (because the underlying Pango library always uses {Wx::FontEncoding::FONTENCODING_UTF8}).
     # @see Wx::Font#get_encoding 
-    # @param encoding [FontEncoding] 
+    # @param encoding [Wx::FontEncoding] 
     # @return [void]
     def set_encoding(encoding) end
     alias_method :encoding=, :set_encoding
@@ -902,7 +902,7 @@ module Wx
     # @see Wx::Font#get_face_name
     # @see  Wx::Font#set_family 
     # @param faceName [String]  A valid facename, which should be on the end-user's system.
-    # @return [true,false]
+    # @return [Boolean]
     def set_face_name(faceName) end
     alias_method :face_name=, :set_face_name
     
@@ -911,7 +911,7 @@ module Wx
     # Note that changing the font family results in changing the font face name.
     # @see Wx::Font#get_family
     # @see  Wx::Font#set_face_name 
-    # @param family [FontFamily]  One of the {Wx::FontFamily} values.
+    # @param family [Wx::FontFamily]  One of the {Wx::FontFamily} values.
     # @return [void]
     def set_family(family) end
     alias_method :family=, :set_family
@@ -921,7 +921,7 @@ module Wx
     # true if the creation was successful.
     # @see Wx::Font#set_native_font_info_user_desc 
     # @param info [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_native_font_info(info) end
     alias_method :native_font_info=, :set_native_font_info
     
@@ -932,21 +932,21 @@ module Wx
     # generic syntax 
     # example 
     # 
-    # {Wx::GTK2} 
+    # wxGTK2 
     # <code>[underlined] [strikethrough] [FACE-NAME] [bold] [oblique|italic] [POINTSIZE]</code> 
     # Monospace bold 10 
     # 
-    # {Wx::MSW} 
+    # wxMSW 
     # <code>[light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING]</code> 
     # Tahoma 10 WINDOWS-1252 
     # 
     # Todoadd an example for {Wx::Mac}
     # 
     # For more detailed information about the allowed syntaxes you can look at the documentation of the native API used for font-rendering (e.g. pango_font_description_from_string under GTK, although notice that it doesn't support the "underlined" and "strikethrough" attributes and so those are handled by wxWidgets itself).
-    # Note that unlike {Wx::Font#set_native_font_info}, this function doesn't always restore all attributes of the {Wx::Font} object under all platforms; e.g. on {Wx::MSW} the font family is not restored (because GetNativeFontInfoUserDesc doesn't return it on {Wx::MSW}). If you want to serialize/deserialize a font in string form, you should use {Wx::Font#get_native_font_info_desc} and {Wx::Font#set_native_font_info} instead.
+    # Note that unlike {Wx::Font#set_native_font_info}, this function doesn't always restore all attributes of the {Wx::Font} object under all platforms; e.g. on wxMSW the font family is not restored (because GetNativeFontInfoUserDesc doesn't return it on wxMSW). If you want to serialize/deserialize a font in string form, you should use {Wx::Font#get_native_font_info_desc} and {Wx::Font#set_native_font_info} instead.
     # @see Wx::Font#set_native_font_info 
     # @param info [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_native_font_info_user_desc(info) end
     alias_method :native_font_info_user_desc=, :set_native_font_info_user_desc
     
@@ -968,7 +968,7 @@ module Wx
     
     # Sets the pixel size.
     # The height parameter of pixelSize must be positive while the width parameter may also be zero (to indicate that you're not interested in the width of the characters: a suitable width will be chosen for best rendering).
-    # This feature (specifying the font pixel size) is directly supported only under {Wx::MSW} and {Wx::GTK} currently; under other platforms a font with the closest size to the given one is found using binary search (this maybe slower).
+    # This feature (specifying the font pixel size) is directly supported only under wxMSW and wxGTK currently; under other platforms a font with the closest size to the given one is found using binary search (this maybe slower).
     # @see Wx::Font#get_pixel_size 
     # @param pixelSize [Array(Integer, Integer), Wx::Size] 
     # @return [void]
@@ -978,7 +978,7 @@ module Wx
     # Sets the font style.
     # 
     # @see Wx::Font#get_style 
-    # @param style [FontStyle]  One of the {Wx::FontStyle} enumeration values.
+    # @param style [Wx::FontStyle]  One of the {Wx::FontStyle} enumeration values.
     # @return [void]
     def set_style(style) end
     alias_method :style=, :set_style
@@ -986,14 +986,14 @@ module Wx
     # Sets the font size using a predefined symbolic size name.
     # This function allows changing font size to be (very) large or small compared to the standard font size.
     # @see Wx::Font#set_symbolic_size_relative_to.
-    # @param size [FontSymbolicSize] 
+    # @param size [Wx::FontSymbolicSize] 
     # @return [void]
     def set_symbolic_size(size) end
     alias_method :symbolic_size=, :set_symbolic_size
     
     # Sets the font size compared to the base font size.
     # This is the same as {Wx::Font#set_symbolic_size} except that it uses the given font size as the normal font size instead of the standard font size.
-    # @param size [FontSymbolicSize] 
+    # @param size [Wx::FontSymbolicSize] 
     # @param base [Integer] 
     # @return [void]
     def set_symbolic_size_relative_to(size, base) end
@@ -1001,15 +1001,15 @@ module Wx
     # Sets underlining.
     # 
     # @see Wx::Font#get_underlined 
-    # @param underlined [true,false]  true to underline, false otherwise.
+    # @param underlined [Boolean]  true to underline, false otherwise.
     # @return [void]
     def set_underlined(underlined) end
     alias_method :underlined=, :set_underlined
     
     # Sets strike-through attribute of the font.
-    # Currently stricken-through fonts are only supported in {Wx::MSW}, {Wx::GTK}, and {Wx::OSX}.
+    # Currently stricken-through fonts are only supported in wxMSW, wxGTK, and wxOSX.
     # @see Wx::Font#get_strikethrough
-    # @param strikethrough [true,false]  true to add strike-through style, false to remove it.
+    # @param strikethrough [Boolean]  true to add strike-through style, false to remove it.
     # @return [void]
     def set_strikethrough(strikethrough) end
     alias_method :strikethrough=, :set_strikethrough
@@ -1017,7 +1017,7 @@ module Wx
     # Sets the font weight.
     # 
     # @see Wx::Font#get_weight 
-    # @param weight [FontWeight]  One of the {Wx::FontWeight} values.
+    # @param weight [Wx::FontWeight]  One of the {Wx::FontWeight} values.
     # @return [void]
     def set_weight(weight) end
     alias_method :weight=, :set_weight
@@ -1034,46 +1034,41 @@ module Wx
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pointSize [Integer] 
-    #   @param family [FontFamily] 
-    #   @param style [FontStyle] 
-    #   @param weight [FontWeight] 
-    #   @param underline [true,false] 
+    #   @param family [Wx::FontFamily] 
+    #   @param style [Wx::FontStyle] 
+    #   @param weight [Wx::FontWeight] 
+    #   @param underline [Boolean] 
     #   @param faceName [String] 
-    #   @param encoding [FontEncoding] 
+    #   @param encoding [Wx::FontEncoding] 
     #   @return [Wx::Font]
     # @overload self.create(pointSize, family, flags=Wx::FontFlag::FONTFLAG_DEFAULT, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pointSize [Integer] 
-    #   @param family [FontFamily] 
+    #   @param family [Wx::FontFamily] 
     #   @param flags [Integer] 
     #   @param faceName [String] 
-    #   @param encoding [FontEncoding] 
+    #   @param encoding [Wx::FontEncoding] 
     #   @return [Wx::Font]
     # @overload self.create(pixelSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pixelSize [Array(Integer, Integer), Wx::Size] 
-    #   @param family [FontFamily] 
-    #   @param style [FontStyle] 
-    #   @param weight [FontWeight] 
-    #   @param underline [true,false] 
+    #   @param family [Wx::FontFamily] 
+    #   @param style [Wx::FontStyle] 
+    #   @param weight [Wx::FontWeight] 
+    #   @param underline [Boolean] 
     #   @param faceName [String] 
-    #   @param encoding [FontEncoding] 
+    #   @param encoding [Wx::FontEncoding] 
     #   @return [Wx::Font]
     # @overload self.create(pixelSize, family, flags=Wx::FontFlag::FONTFLAG_DEFAULT, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pixelSize [Array(Integer, Integer), Wx::Size] 
-    #   @param family [FontFamily] 
+    #   @param family [Wx::FontFamily] 
     #   @param flags [Integer] 
     #   @param faceName [String] 
-    #   @param encoding [FontEncoding] 
-    #   @return [Wx::Font]
-    # @overload self.create(nativeInfo)
-    #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
-    #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
-    #   @param nativeInfo [Wx::NativeFontInfo] 
+    #   @param encoding [Wx::FontEncoding] 
     #   @return [Wx::Font]
     # @overload self.create(nativeInfoString)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
@@ -1084,76 +1079,77 @@ module Wx
     
     # @overload initialize()
     #   Default ctor.
-    #   @return [Font]
+    #   @return [Wx::Font]
     # @overload initialize(font)
     #   Copy constructor, uses reference counting.
     #   @param font [Wx::Font,Wx::FontInfo] 
-    #   @return [Font]
+    #   @return [Wx::Font]
     # @overload initialize(fontInfo)
     #   Creates a font object using the specified font description.
     #   This is the preferred way to create font objects as using this ctor results in more readable code and it is also extensible, e.g. it could continue to be used if support for more font attributes is added in the future. For example, this constructor provides the only way of creating fonts with strike-through style.
     #   Example of creating a font using this ctor: 
-    #   ```
-    #     wxFont font(wxFontInfo(10).Bold().Underlined());
+    #   ```ruby
+    #     font = Wx::Font.new(Wx::FontInfo.new(10).bold().underlined())
     #   ```
     #   @param fontInfo [Wx::FontInfo] 
-    #   @return [Font]
+    #   @return [Wx::Font]
     # @overload initialize(pointSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   Creates a font object with the specified attributes and size in points.
     #   Notice that the use of this constructor is often more verbose and less readable than using wxFont(const wxFontInfo& font), e.g. the example in that constructor documentation would need to be written as:
     #   
-    #   ```
-    #     wxFont font(10, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL,
-    #                 wxFONTWEIGHT_BOLD, true);
+    #   ```ruby
+    #     font = Wx::Font.new(10, Wx::FontFamily::FONTFAMILY_DEFAULT, 
+    #                         Wx::FontStyle::FONTSTYLE_NORMAL, 
+    #                         Wx::FontWeight::FONTWEIGHT_BOLD, true)
     #   ```
     #   
     #   If the desired font does not exist, the closest match will be chosen. Under Windows, only scalable TrueType fonts are used.
     #   @param pointSize [Integer]  Size in points. See {Wx::Font#set_point_size} for more info. Notice that, for historical reasons, the value 70 here is interpreted at {Wx::DEFAULT} and results in creation of the font with the default size and not of a font with the size of 70pt. If you really need the latter, please use SetPointSize(70). Note that this constructor and the matching Create() method overload are the only places in {Wx::Font} API handling {Wx::DEFAULT} specially: neither {Wx::Font#set_point_size} nor the constructor taking {Wx::FontInfo} handle this value in this way.
-    #   @param family [FontFamily]  The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the {Wx::FontFamily} enumeration values. If the faceName argument is provided, then it overrides the font family.
-    #   @param style [FontStyle]  One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
-    #   @param weight [FontWeight]  Font weight, sometimes also referred to as font boldness. One of the {Wx::FontWeight} enumeration values.
-    #   @param underline [true,false]  The value can be true or false. At present this has an effect on Windows and Motif 2.x only.
+    #   @param family [Wx::FontFamily]  The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the {Wx::FontFamily} enumeration values. If the faceName argument is provided, then it overrides the font family.
+    #   @param style [Wx::FontStyle]  One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
+    #   @param weight [Wx::FontWeight]  Font weight, sometimes also referred to as font boldness. One of the {Wx::FontWeight} enumeration values.
+    #   @param underline [Boolean]  The value can be true or false. At present this has an effect on Windows and Motif 2.x only.
     #   @param faceName [String]  An optional string specifying the face name to be used. If it is an empty string, a default face name will be chosen based on the family.
-    #   @param encoding [FontEncoding]  An encoding which may be one of the enumeration values of {Wx::FontEncoding}. If the specified encoding isn't available, no font is created (see also Font Encodings).
-    #   @return [Font]
+    #   @param encoding [Wx::FontEncoding]  An encoding which may be one of the enumeration values of {Wx::FontEncoding}. If the specified encoding isn't available, no font is created (see also Font Encodings).
+    #   @return [Wx::Font]
     # @overload initialize(pixelSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   Creates a font object with the specified attributes and size in pixels.
     #   Notice that the use of this constructor is often more verbose and less readable than the use of constructor from {Wx::FontInfo}, consider using that constructor instead.
     #   
     #   If the desired font does not exist, the closest match will be chosen. Under Windows, only scalable TrueType fonts are used.
     #   @param pixelSize [Array(Integer, Integer), Wx::Size]  Size in pixels. See {Wx::Font#set_pixel_size} for more info.
-    #   @param family [FontFamily]  The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the {Wx::FontFamily} enumeration values. If the faceName argument is provided, then it overrides the font family.
-    #   @param style [FontStyle]  One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
-    #   @param weight [FontWeight]  Font weight, sometimes also referred to as font boldness. One of the {Wx::FontWeight} enumeration values.
-    #   @param underline [true,false]  The value can be true or false. At present this has an effect on Windows and Motif 2.x only.
+    #   @param family [Wx::FontFamily]  The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the {Wx::FontFamily} enumeration values. If the faceName argument is provided, then it overrides the font family.
+    #   @param style [Wx::FontStyle]  One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
+    #   @param weight [Wx::FontWeight]  Font weight, sometimes also referred to as font boldness. One of the {Wx::FontWeight} enumeration values.
+    #   @param underline [Boolean]  The value can be true or false. At present this has an effect on Windows and Motif 2.x only.
     #   @param faceName [String]  An optional string specifying the face name to be used. If it is an empty string, a default face name will be chosen based on the family.
-    #   @param encoding [FontEncoding]  An encoding which may be one of the enumeration values of {Wx::FontEncoding}. If the specified encoding isn't available, no font is created (see also Font Encodings).
-    #   @return [Font]
+    #   @param encoding [Wx::FontEncoding]  An encoding which may be one of the enumeration values of {Wx::FontEncoding}. If the specified encoding isn't available, no font is created (see also Font Encodings).
+    #   @return [Wx::Font]
     # @overload initialize(nativeInfoString)
     #   Constructor from font description string.
     #   This constructor uses {Wx::Font#set_native_font_info} to initialize the font. If fontdesc is invalid the font remains uninitialized, i.e. its {Wx::Font#is_ok} method will return false.
     #   @param nativeInfoString [String] 
-    #   @return [Font]
+    #   @return [Wx::Font]
     def initialize(*args) end
     
     # Equality operator.
     # See reference-counted object comparison for more info.
     # @param font [Wx::Font,Wx::FontInfo] 
-    # @return [true,false]
+    # @return [Boolean]
     def ==(font) end
     
     # Returns the current application's default encoding.
     # 
     # @see Font Encodings
     # @see  Wx::Font.set_default_encoding 
-    # @return [FontEncoding]
+    # @return [Wx::FontEncoding]
     def self.get_default_encoding; end
     
     # Sets the default font encoding.
     # 
     # @see Font Encodings
     # @see  Wx::Font.get_default_encoding 
-    # @param encoding [FontEncoding] 
+    # @param encoding [Wx::FontEncoding] 
     # @return [void]
     def self.set_default_encoding(encoding) end
     
@@ -1161,7 +1157,7 @@ module Wx
     # For compatibility, this function handles the values {Wx::NORMAL}, {Wx::LIGHT} and {Wx::BOLD}, that have values 90, 91 and 92, specially and converts them to the corresponding {Wx::FONTWEIGHT_XXX} weight value.
     # 
     # Numeric weight, between 1 and 1000.
-    # @param weight [FontWeight]  A valid element of {Wx::FontWeight} enum, i.e. this argument can't have value {Wx::FontWeight::FONTWEIGHT_INVALID}.
+    # @param weight [Wx::FontWeight]  A valid element of {Wx::FontWeight} enum, i.e. this argument can't have value {Wx::FontWeight::FONTWEIGHT_INVALID}.
     # @return [Integer]
     def self.get_numeric_weight_of(weight) end
     
@@ -1169,8 +1165,8 @@ module Wx
   
   # This class is a helper used for {Wx::Font} creation using named parameter idiom: it allows specifying various {Wx::Font} attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to {Wx::Font} constructors.
   # For example, to create an italic font with the given face name and size you could use: 
-  # ```
-  #   wxFont font(wxFontInfo(12).FaceName("Helvetica").Italic());
+  # ```ruby
+  #   font = Wx::Font.new(Wx::FontInfo.new(12).face_name('Helvetica').italic())
   # ```
   # 
   # Notice that all of the methods of this object return a reference to the object itself, allowing the calls to them to be chained as in the example above.
@@ -1182,26 +1178,26 @@ module Wx
   
     # @overload initialize()
     #   Default constructor uses the default font size for the current platform.
-    #   @return [FontInfo]
+    #   @return [Wx::FontInfo]
     # @overload initialize(pointSize)
     #   Constructor setting the font size in points to use.
     #   Note that until wxWidgets 3.1.2 fractional point sizes were not supported, and the type of pointSize was int.
     #   @see Wx::Font#set_point_size 
     #   @param pointSize [Float] 
-    #   @return [FontInfo]
+    #   @return [Wx::FontInfo]
     # @overload initialize(pixelSize)
     #   Constructor setting the font size in pixels to use.
     #   
     #   @see Wx::Font#set_pixel_size 
     #   @param pixelSize [Array(Integer, Integer), Wx::Size] 
-    #   @return [FontInfo]
+    #   @return [Wx::FontInfo]
     def initialize(*args) end
     
     # Set the font family.
     # The family is a generic portable way of referring to fonts without specifying a precise face name. This parameter must be one of the {Wx::FontFamily} enumeration values.
     # If the {Wx::FontInfo#face_name} is used, then it overrides the font family.
     # @see Wx::Font#set_family 
-    # @param family [FontFamily] 
+    # @param family [Wx::FontFamily] 
     # @return [Wx::FontInfo]
     def family(family) end
     
@@ -1221,7 +1217,7 @@ module Wx
     # This is a wrapper for {Wx::FontInfo#weight} calling it with {Wx::FontWeight::FONTWEIGHT_BOLD} argument.
     # @see Wx::FontWeight
     # @see  Wx::Font#set_weight 
-    # @param bold [true,false] 
+    # @param bold [Boolean] 
     # @return [Wx::FontInfo]
     def bold(bold=true) end
     
@@ -1229,7 +1225,7 @@ module Wx
     # This is a wrapper for {Wx::FontInfo#weight} calling it with {Wx::FontWeight::FONTWEIGHT_LIGHT} argument.
     # @see Wx::FontWeight
     # @see  Wx::Font#set_weight 
-    # @param light [true,false] 
+    # @param light [Boolean] 
     # @return [Wx::FontInfo]
     def light(light=true) end
     
@@ -1237,7 +1233,7 @@ module Wx
     # This is a wrapper for {Wx::FontInfo#style} calling it with {Wx::FontStyle::FONTSTYLE_ITALIC} argument.
     # @see Wx::FontStyle
     # @see  Wx::Font#set_style 
-    # @param italic [true,false] 
+    # @param italic [Boolean] 
     # @return [Wx::FontInfo]
     def italic(italic=true) end
     
@@ -1245,30 +1241,30 @@ module Wx
     # This is a wrapper for {Wx::FontInfo#style} calling it with {Wx::FontStyle::FONTSTYLE_SLANT} argument.
     # @see Wx::FontStyle
     # @see  Wx::Font#set_style 
-    # @param slant [true,false] 
+    # @param slant [Boolean] 
     # @return [Wx::FontInfo]
     def slant(slant=true) end
     
     # Specify the style of the font using one of {Wx::FontStyle} constants.
-    # @param style [FontStyle] 
+    # @param style [Wx::FontStyle] 
     # @return [Wx::FontInfo]
     def style(style) end
     
     # Set anti-aliasing flag.
     # Force the use of anti-aliasing on or off.
     # Currently this is not implemented, i.e. using this method doesn't do anything.
-    # @param antiAliased [true,false] 
+    # @param antiAliased [Boolean] 
     # @return [Wx::FontInfo]
     def anti_aliased(antiAliased=true) end
     
     # Use an underlined version of the font.
-    # @param underlined [true,false] 
+    # @param underlined [Boolean] 
     # @return [Wx::FontInfo]
     def underlined(underlined=true) end
     
     # Use a strike-through version of the font.
-    # Currently this is only implemented in {Wx::MSW}, {Wx::GTK}, and {Wx::OSX}.
-    # @param strikethrough [true,false] 
+    # Currently this is only implemented in wxMSW, wxGTK, and wxOSX.
+    # @param strikethrough [Boolean] 
     # @return [Wx::FontInfo]
     def strikethrough(strikethrough=true) end
     
@@ -1276,7 +1272,7 @@ module Wx
     # This is mostly unneeded in Unicode builds of wxWidgets.
     # @see Wx::FontEncoding
     # @see  Wx::Font#set_encoding 
-    # @param encoding [FontEncoding] 
+    # @param encoding [Wx::FontEncoding] 
     # @return [Wx::FontInfo]
     def encoding(encoding) end
     
@@ -1290,7 +1286,7 @@ module Wx
     # Get the symbolic weight closest to the given raw weight value.
     # A valid element of {Wx::FontWeight} enum.
     # @param numWeight [Integer]  A valid raw weight value, i.e. a value in the range 1 to 1000, inclusive.
-    # @return [FontWeight]
+    # @return [Wx::FontWeight]
     def self.get_weight_closest_to_numeric_value(numWeight) end
     
   end # FontInfo

data/lib/wx/doc/gen/font_data.rb

@@ -21,20 +21,20 @@ module Wx
   
     # Constructor.
     # Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.
-    # @return [FontData]
+    # @return [Wx::FontData]
     def initialize; end
     
     # Enables or disables "effects" under Windows or generic only.
     # This refers to the controls for manipulating colour, strikeout and underline properties.
     # The default value is true.
-    # @param enable [true,false] 
+    # @param enable [Boolean] 
     # @return [void]
     def enable_effects(enable) end
     
     # Under Windows, returns a flag determining whether symbol fonts can be selected.
     # Has no effect on other platforms.
     # The default value is true.
-    # @return [true,false]
+    # @return [Boolean]
     def get_allow_symbols; end
     alias_method :allow_symbols, :get_allow_symbols
     
@@ -52,13 +52,15 @@ module Wx
     # Determines whether "effects" are enabled under Windows.
     # This refers to the controls for manipulating colour, strikeout and underline properties.
     # The default value is true.
-    # @return [true,false]
+    # @return [Boolean]
     def get_enable_effects; end
     
     # Returns the state of the flags restricting the selection.
-    # Note that currently these flags are only effectively used in {Wx::MSW}.
+    # Note that currently these flags are only effectively used in wxMSW.
     # 
-    # - {Wx::FONTRESTRICT_NONE} If no restriction applies, or a combination of the following flags:- {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.- {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
+    # - {Wx::FONTRESTRICT_NONE} If no restriction applies, or a combination of the following flags:
+    # - {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.
+    # - {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
     # 
     # The default value is {Wx::FONTRESTRICT_NONE}.
     # @return [Integer]
@@ -72,15 +74,17 @@ module Wx
     
     # Returns true if the Help button will be shown (Windows only).
     # The default value is false.
-    # @return [true,false]
+    # @return [Boolean]
     def get_show_help; end
     alias_method :show_help, :get_show_help
     
     # Restricts the selection to a subset of the available fonts.
-    # Note that currently these flags are only effectively used in {Wx::MSW} and are ignored in the other ports.
+    # Note that currently these flags are only effectively used in wxMSW and are ignored in the other ports.
     # Possible values are:
     # 
-    # - {Wx::FONTRESTRICT_NONE} No restriction, show all fonts in the dialog.- {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.- {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
+    # - {Wx::FONTRESTRICT_NONE} No restriction, show all fonts in the dialog.
+    # - {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.
+    # - {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
     # 
     # The default value is {Wx::FONTRESTRICT_NONE}.
     # @param flags [Integer] 
@@ -90,7 +94,7 @@ module Wx
     # Under Windows, determines whether symbol fonts can be selected.
     # Has no effect on other platforms.
     # The default value is true.
-    # @param allowSymbols [true,false] 
+    # @param allowSymbols [Boolean] 
     # @return [void]
     def set_allow_symbols(allowSymbols) end
     alias_method :allow_symbols=, :set_allow_symbols
@@ -123,7 +127,7 @@ module Wx
     
     # Determines whether the Help button will be displayed in the font dialog (Windows only).
     # The default value is false.
-    # @param showHelp [true,false] 
+    # @param showHelp [Boolean] 
     # @return [void]
     def set_show_help(showHelp) end
     alias_method :show_help=, :set_show_help