wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -66,6 +66,7 @@ module Wx
   end # HelpSearchMode
   
   # This is an alias for one of a family of help controller classes which is most appropriate for the current platform.
+  # 
   # A help controller allows an application to display help, at the contents or at a particular topic, and shut the help program down on termination. This avoids proliferation of many instances of the help viewer whenever the user requests a different topic via the application's menus or buttons.
   # Typically, an application will create a help controller instance when it starts, and immediately call {Wx::HelpController::Initialize} to associate a filename with it. The help viewer will only get run, however, just before the first call to display something.
   # Most help controller classes actually derive from {Wx::HelpControllerBase} and have names of the form {Wx::XXXHelpController} or {Wx::HelpControllerXXX}. An appropriate class is aliased to the name {Wx::HelpController} for each platform, as follows:
@@ -91,6 +92,7 @@ module Wx
   class HelpController < Object
   
     # Constructs a help instance object, but does not invoke the help viewer.
+    # 
     # If you provide a window, it will be used by some help controller classes, such as {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}, as the parent for the help window instead of the value of {Wx::App#get_top_window}.
     # You can also change the parent window later with {Wx::HelpController#set_parent_window}.
     # @param parentWindow [Wx::Window] 
@@ -102,12 +104,14 @@ module Wx
     def display_contents; end
     
     # Displays the section as a popup window using a context id.
+    # 
     # Returns false if unsuccessful or not implemented.
     # @param contextId [Integer] 
     # @return [Boolean]
     def display_context_popup(contextId) end
     
     # Displays the text in a popup window, if possible.
+    # 
     # Returns false if unsuccessful or not implemented.
     # @param text [String] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
@@ -115,12 +119,14 @@ module Wx
     def display_text_popup(text, pos) end
     
     # Returns the window to be used as the parent for the help window.
+    # 
     # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
     # @return [Wx::Window]
     def get_parent_window; end
     alias_method :parent_window, :get_parent_window
     
     # Initializes the help instance with a help filename.
+    # 
     # Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.
     # You may omit the file extension and a suitable one will be chosen. For {Wx::HTML::HtmlHelpController}, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.
     # @param file [String] 
@@ -128,6 +134,7 @@ module Wx
     def init(file) end
     
     # If the help viewer is not running, runs it, and searches for sections matching the given keyword.
+    # 
     # If one match is found, the file is displayed at this section. The optional parameter allows searching the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently is only supported by the {Wx::HTML::HtmlHelpController}.
     # 
     # - WinHelp, MS HTML Help: If more than one match is found, the first topic is displayed.
@@ -140,11 +147,13 @@ module Wx
     def keyword_search(keyWord, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
     
     # Overridable member called when this application's viewer is quit by the user.
+    # 
     # This does not work for all help controllers.
     # @return [void]
     def on_quit; end
     
     # Set the parameters of the frame window.
+    # 
     # For {Wx::HTML::HtmlHelpController}, titleFormat specifies the title string format (with s being replaced by the actual page title) and size and position specify the geometry of the frame.
     # For all other help controllers this function has no effect.
     # Finally, newFrameEachTime is always ignored currently.
@@ -156,6 +165,7 @@ module Wx
     def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
     
     # Sets the window to be used as the parent for the help window.
+    # 
     # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
     # @param parentWindow [Wx::Window] 
     # @return [void]
@@ -163,6 +173,7 @@ module Wx
     alias_method :parent_window=, :set_parent_window
     
     # Sets detailed viewer information.
+    # 
     # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
     # 
     # ```ruby

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

@@ -7,6 +7,7 @@
 module Wx
 
   # {Wx::HelpProvider} is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.
+  # 
   # The current help provider must be explicitly set by the application using {Wx::HelpProvider.set}.
   # 
   # Category:  {Wx::HELP}
@@ -23,29 +24,32 @@ module Wx
   
     # @overload add_help(window, text)
     #   Associates the text with the given window.
+    #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param window [Wx::Window] 
     #   @param text [String] 
     #   @return [void]
     # @overload add_help(id, text)
     #   Associates the text with the given ID.
+    #   
     #   This help text will be shown for all windows with ID id, unless they have more specific help text associated using the other {Wx::HelpProvider#add_help} prototype. May be used to set the same help string for all Cancel buttons in the application, for example.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>Although all help providers have these functions to allow making {Wx::Window#set_help_text} work, not all of them implement the functions. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param id [Integer] 
     #   @param text [String] 
     #   @return [void]
     def add_help(*args) end
     
     # This version associates the given text with all windows with this id.
+    # 
     # May be used to set the same help string for all Cancel buttons in the application, for example.
     # @param window [Wx::Window] 
     # @return [String]
@@ -53,31 +57,36 @@ module Wx
     alias_method :help, :get_help
     
     # Removes the association between the window pointer and the help text.
+    # 
     # This is called by the {Wx::Window} destructor. Without this, the table of help strings will fill up and when window pointers are reused, the wrong help string will be found.
     # @param window [Wx::Window] 
     # @return [void]
     def remove_help(window) end
     
     # Shows help for the given window.
+    # 
     # Override this function if the help doesn't depend on the exact position inside the window, otherwise you need to override {Wx::HelpProvider#show_help_at_point}. Returns true if help was shown, or false if no help was available for this window.
     # @param window [Wx::Window] 
     # @return [Boolean]
     def show_help(window) end
     
     # This function may be overridden to show help for the window when it should depend on the position inside the window, By default this method forwards to {Wx::HelpProvider#show_help}, so it is enough to only implement the latter if the help doesn't depend on the position.
+    # 
     # true if help was shown, or false if no help was available for this window.
     # @param window [Wx::Window]  Window to show help text for.
     # @param point [Array(Integer, Integer), Wx::Point]  Coordinates of the mouse at the moment of help event emission.
-    # @param origin [Wx::wxHelpEvent::Origin]  Help event origin, see {Wx::HelpEvent#get_origin}.
+    # @param origin [Wx::HelpEvent::Origin]  Help event origin, see {Wx::HelpEvent#get_origin}.
     # @return [Boolean]
     def show_help_at_point(window, point, origin) end
     
     # Returns pointer to help provider instance.
+    # 
     # Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application using {Wx::HelpProvider.set}.
     # @return [Wx::HelpProvider]
     def self.get; end
     
     # Set the current, application-wide help provider.
+    # 
     # Pointer to previous help provider or NULL if there wasn't any.
     # @param helpProvider [Wx::HelpProvider] 
     # @return [Wx::HelpProvider]

data/lib/wx/doc/gen/html/html_cell.rb

@@ -124,6 +124,7 @@ module Wx::HTML
   end # HtmlScriptMode
   
   # Internal data structure.
+  # 
   # It represents fragments of parsed HTML page, the so-called <b>cell</b> - a word, picture, table, horizontal line and so on. It is used by {Wx::HTML::HtmlWindow} and {Wx::HtmlWinParser} to represent HTML page in memory.
   # You can divide cells into two groups : visible cells with non-zero width and height and helper cells (usually with zero width and height) that perform special actions such as color or font change.
   # 
@@ -140,6 +141,7 @@ module Wx::HTML
     def initialize; end
     
     # Find a cell inside this cell positioned at the given coordinates (relative to this's positions).
+    # 
     # Returns NULL if no such cell exists. The flag can be used to specify whether to look for terminal or nonterminal cells or both. In either case, returned cell is deepest cell in cells tree that contains [x,y].
     # @param x [Integer] 
     # @param y [Integer] 
@@ -148,12 +150,14 @@ module Wx::HTML
     def find_cell_by_pos(x, y, flags=Wx::HTML::HTML_FIND_EXACT) end
     
     # Returns descent value of the cell (m_Descent member).
+    # 
     # See explanation:
     # @return [Integer]
     def get_descent; end
     alias_method :descent, :get_descent
     
     # Returns pointer to the first cell in the list.
+    # 
     # You can then use child's {Wx::HTML::HtmlCell#get_next} method to obtain pointer to the next cell in list.
     # 
     # <div class="wxrb-note">
@@ -176,6 +180,7 @@ module Wx::HTML
     alias_method :id, :get_id
     
     # Returns hypertext link if associated with this cell or NULL otherwise.
+    # 
     # See {Wx::HTML::HtmlLinkInfo}. (Note: this makes sense only for visible tags).
     # @param x [Integer]  Coordinates of position where the user pressed mouse button. These coordinates are used e.g. by COLORMAP. Values are relative to the upper left corner of THIS cell (i.e. from 0 to m_Width or m_Height)
     # @param y [Integer] 
@@ -194,12 +199,14 @@ module Wx::HTML
     alias_method :parent, :get_parent
     
     # Returns X position within parent (the value is relative to parent's upper left corner).
+    # 
     # The returned value is meaningful only if parent's {Wx::HTML::HtmlCell#layout} was called before!
     # @return [Integer]
     def get_pos_x; end
     alias_method :pos_x, :get_pos_x
     
     # Returns Y position within parent (the value is relative to parent's upper left corner).
+    # 
     # The returned value is meaningful only if parent's {Wx::HTML::HtmlCell#layout} was called before!
     # @return [Integer]
     def get_pos_y; end
@@ -211,6 +218,7 @@ module Wx::HTML
     alias_method :width, :get_width
     
     # Sets unique cell identifier.
+    # 
     # Default value is no identifier, i.e. empty string.
     # @param id [String] 
     # @return [void]
@@ -218,6 +226,7 @@ module Wx::HTML
     alias_method :id=, :set_id
     
     # Sets the hypertext link associated with this cell.
+    # 
     # (Default value is {Wx::HTML::HtmlLinkInfo}("", "") (no link))
     # @param link [Wx::HTML::HtmlLinkInfo] 
     # @return [void]
@@ -225,6 +234,7 @@ module Wx::HTML
     alias_method :link=, :set_link
     
     # Sets the next cell in the list.
+    # 
     # This shouldn't be called by user - it is to be used only by {Wx::HTML::HtmlContainerCell#insert_cell}.
     # @param cell [Wx::HTML::HtmlCell] 
     # @return [void]
@@ -232,6 +242,7 @@ module Wx::HTML
     alias_method :next_=, :set_next
     
     # Sets parent container of this cell.
+    # 
     # This is called from {Wx::HTML::HtmlContainerCell#insert_cell}.
     # @param p [Wx::HTML::HtmlContainerCell] 
     # @return [void]
@@ -245,6 +256,7 @@ module Wx::HTML
     def set_pos(x, y) end
     
     # Converts the cell into text representation.
+    # 
     # If sel != NULL then only part of the cell inside the selection is converted.
     # @param sel [Wx::HTML::HtmlSelection] 
     # @return [String]
@@ -253,6 +265,7 @@ module Wx::HTML
   end # HtmlCell
   
   # This class stores all necessary information about hypertext links (as represented by <A> tag in HTML documents).
+  # 
   # In current implementation it stores URL and target frame name.
   # 
   # <div class="wxrb-note">
@@ -279,6 +292,7 @@ module Wx::HTML
     def initialize(*args) end
     
     # Return pointer to event that generated OnLinkClicked() event.
+    # 
     # Valid only within {Wx::HTML::HtmlWindow#on_link_clicked}, NULL otherwise.
     # @return [Wx::MouseEvent]
     def get_event; end
@@ -290,6 +304,7 @@ module Wx::HTML
     alias_method :href, :get_href
     
     # Return pointer to the cell that was clicked.
+    # 
     # Valid only within {Wx::HTML::HtmlWindow#on_link_clicked}, NULL otherwise.
     # @return [Wx::HTML::HtmlCell]
     def get_html_cell; end
@@ -303,6 +318,7 @@ module Wx::HTML
   end # HtmlLinkInfo
   
   # The {Wx::HTML::HtmlContainerCell} class is an implementation of a cell that may contain more cells in it.
+  # 
   # It is heavily used in the {Wx::HTML} layout algorithm.
   # 
   # Category:  {Wx::HTML}
@@ -313,12 +329,14 @@ module Wx::HTML
   class HtmlContainerCell < HtmlCell
   
     # Constructor.
+    # 
     # parent is pointer to parent container or NULL.
     # @param parent [Wx::HTML::HtmlContainerCell] 
     # @return [Wx::HTML::HtmlContainerCell]
     def initialize(parent) end
     
     # Detach a child cell.
+    # 
     # Detaching a cell removes it from this container and allows reattaching it to another one by using {Wx::HTML::HtmlContainerCell#insert_cell}. Alternatively, this method can be used to selectively remove some elements of the HTML document tree by deleting the cell after calling it.
     # @param cell [Wx::HTML::HtmlCell]  Must be non-null and an immediate child of this cell.
     # @return [void]
@@ -340,6 +358,7 @@ module Wx::HTML
     alias_method :background_colour, :get_background_colour
     
     # Returns the indentation.
+    # 
     # ind is one of the <b>{Wx::HTML_INDENT_}*</b> constants.
     # 
     # <div class="wxrb-note">
@@ -359,12 +378,14 @@ module Wx::HTML
     alias_method :indent_units, :get_indent_units
     
     # Inserts a new cell into the container.
+    # 
     # Note that the container takes ownership of the cell and will delete it when it itself is destroyed.
     # @param cell [Wx::HTML::HtmlCell] 
     # @return [void]
     def insert_cell(cell) end
     
     # Sets the container's horizontal alignment.
+    # 
     # During {Wx::HTML::HtmlCell#layout} each line is aligned according to al value.
     # @param al [Integer]  new horizontal alignment. May be one of these values:
     #   
@@ -377,6 +398,7 @@ module Wx::HTML
     alias_method :align_hor=, :set_align_hor
     
     # Sets the container's vertical alignment.
+    # 
     # This is per-line alignment!
     # @param al [Integer]  new vertical alignment. May be one of these values:
     #   
@@ -394,6 +416,7 @@ module Wx::HTML
     alias_method :background_colour=, :set_background_colour
     
     # Sets the border (frame) colours.
+    # 
     # A border is a rectangle around the container.
     # @param clr1 [Wx::Colour,String,Symbol]  Colour of top and left lines
     # @param clr2 [Wx::Colour,String,Symbol]  Colour of bottom and right lines
@@ -420,6 +443,7 @@ module Wx::HTML
     def set_indent(i, what, units=Wx::HTML::HTML_UNITS_PIXELS) end
     
     # Sets minimal height of the container.
+    # 
     # When container's {Wx::HTML::HtmlCell#layout} is called, m_Height is set depending on layout of subcells to the height of area covered by layed-out subcells. Calling this method guarantees you that the height of container is never smaller than h - even if the subcells cover much smaller area.
     # @param h [Integer]  The minimal height.
     # @param align [Integer]  If height of the container is lower than the minimum height, empty space must be inserted somewhere in order to ensure minimal height. This parameter is one of {Wx::HTML::HTML_ALIGN_TOP}, {Wx::HTML::HTML_ALIGN_BOTTOM}, {Wx::HTML::HTML_ALIGN_CENTER}. It refers to the contents, not to the empty place.
@@ -433,6 +457,7 @@ module Wx::HTML
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_HTML
   class HtmlSelection < ::Object

data/lib/wx/doc/gen/html/html_cell_event.rb

@@ -7,6 +7,7 @@
 module Wx::HTML
 
   # This event class is used for the events generated by {Wx::HTML::HtmlWindow}.
+  # 
   # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HTML::HtmlCellEvent} events.
@@ -22,7 +23,7 @@ module Wx::HTML
   class HtmlCellEvent < CommandEvent
   
     # The constructor is not normally used by the user code.
-    # @param commandType [Wx::Slider::EventType] 
+    # @param commandType [Wx::StaticLine::EventType] 
     # @param id [Integer] 
     # @param cell [Wx::HTML::HtmlCell] 
     # @param point [Array(Integer, Integer), Wx::Point] 
@@ -51,6 +52,7 @@ module Wx::HTML
     alias_method :mouse_event, :get_mouse_event
     
     # Call this function with linkclicked set to true if the cell which has been clicked contained a link or false otherwise (which is the default).
+    # 
     # With this function the event handler can return info to the {Wx::HTML::HtmlWindow} which sent the event.
     # @param linkclicked [Boolean] 
     # @return [void]

data/lib/wx/doc/gen/html/html_easy_printing.rb

@@ -19,6 +19,7 @@ module Wx::HTML
   PAGE_ALL = 2
   
   # This class provides very simple interface to printing architecture.
+  # 
   # It allows you to print HTML documents using only a few commands.
   # 
   # <div class="wxrb-note">
@@ -67,6 +68,7 @@ module Wx::HTML
     alias_method :name, :get_name
     
     # Returns a pointer to {Wx::PRT::PageSetupDialogData} instance used by this class.
+    # 
     # You can set its parameters (via SetXXXX methods).
     # @return [Wx::PRT::PageSetupDialogData]
     def get_page_setup_data; end
@@ -78,6 +80,7 @@ module Wx::HTML
     alias_method :parent_window, :get_parent_window
     
     # Returns pointer to {Wx::PRT::PrintData} instance used by this class.
+    # 
     # You can set its parameters (via SetXXXX methods).
     # @return [Wx::PRT::PrintData]
     def get_print_data; end
@@ -88,12 +91,14 @@ module Wx::HTML
     def page_setup; end
     
     # Preview HTML file.
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmlfile [String] 
     # @return [Boolean]
     def preview_file(htmlfile) end
     
     # Preview HTML text (not file!).
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmltext [String]  HTML text.
     # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
@@ -101,12 +106,14 @@ module Wx::HTML
     def preview_text(htmltext, basepath=('')) end
     
     # Print HTML file.
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmlfile [String] 
     # @return [Boolean]
     def print_file(htmlfile) end
     
     # Print HTML text (not file!).
+    # 
     # Returns false in case of error  call {Wx::PRT::Printer.get_last_error} to get detailed information about the kind of the error.
     # @param htmltext [String]  HTML text.
     # @param basepath [String]  base directory (html string would be stored there if it was in file). It is used to determine path for loading images, for example.
@@ -114,6 +121,7 @@ module Wx::HTML
     def print_text(htmltext, basepath=('')) end
     
     # Sets fonts.
+    # 
     # See Wx::HtmlDCRenderer::SetFonts for detailed description.
     # @param normal_face [String] 
     # @param fixed_face [String] 
@@ -128,6 +136,7 @@ module Wx::HTML
     alias_method :name=, :set_name
     
     # Sets default font sizes and/or default font size.
+    # 
     # See Wx::HtmlDCRenderer::SetStandardFonts for detailed description.
     # @see Wx::HTML::HtmlEasyPrinting#set_fonts 
     # @param size [Integer] 
@@ -138,6 +147,7 @@ module Wx::HTML
     alias_method :standard_fonts=, :set_standard_fonts
     
     # Set page footer.
+    # 
     # The following macros can be used inside it: @DATE@ is replaced by the current date in default format @PAGENUM@ is replaced by page number @PAGESCNT@ is replaced by total number of pages @TIME@ is replaced by the current time in default format @TITLE@ is replaced with the title of the document
     # @param footer [String]  HTML text to be used as footer.
     # @param pg [Integer]  one of {Wx::HTML::PAGE_ODD}, {Wx::HTML::PAGE_EVEN} and {Wx::HTML::PAGE_ALL} constants.
@@ -146,6 +156,7 @@ module Wx::HTML
     alias_method :footer=, :set_footer
     
     # Set page header.
+    # 
     # The following macros can be used inside it:
     # 
     # - @DATE@ is replaced by the current date in default format
@@ -166,9 +177,10 @@ module Wx::HTML
     alias_method :parent_window=, :set_parent_window
     
     # Enable or disable showing the dialog before printing.
+    # 
     # The prompt mode determines the value of the prompt parameter passed to {Wx::PRT::Printer#print} when it is called by this class.
     # Default prompt mode value is Prompt_Always.
-    # @param promptMode [Wx::wxHtmlEasyPrinting::PromptMode] 
+    # @param promptMode [Wx::HtmlEasyPrinting::PromptMode] 
     # @return [void]
     def set_prompt_mode(promptMode) end
     alias_method :prompt_mode=, :set_prompt_mode

data/lib/wx/doc/gen/html/html_help_controller.rb

@@ -81,6 +81,7 @@ module Wx::HTML
   end # HelpSearchMode
   
   # This help controller provides an easy way of displaying HTML help in your application (see HTML Sample, test example).
+  # 
   # The help system is based on <b>books</b> (see {Wx::HTML::HtmlHelpController#add_book}). A book is a logical section of documentation (for example "User's Guide" or "Programmer's Guide" or "C++ Reference" or "wxWidgets Reference"). The help controller can handle as many books as you want.
   # Although this class has an API compatible with other wxWidgets help controllers as documented by {Wx::HelpController}, it is recommended that you use the enhanced capabilities of {Wx::HTML::HtmlHelpController}'s API.
   # {Wx::HTML} uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its native format. The file format is described in Help Files Format. The directory helpfiles in the HTML Sample contains sample project files.
@@ -128,6 +129,7 @@ module Wx::HTML
     
     # @overload add_book(bookFile, showWaitMsg=false)
     #   Adds a book (i.e.
+    #   
     #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
     #   This must be called at least once before displaying any help. bookFile or bookUrl may be either <code>".hhp"</code> file or a ZIP archive that contains an arbitrary number of <code>".hhp"</code> files in its top-level directory. This ZIP archive must have <code>".zip"</code> or <code>".htb"</code> extension (the latter stands for "HTML book"). In other words, 
     #   ```ruby
@@ -139,6 +141,7 @@ module Wx::HTML
     #   @return [Boolean]
     # @overload add_book(bookUrl, showWaitMsg=false)
     #   Adds a book (i.e.
+    #   
     #   a .hhp file; an HTML Help Workshop project file) into the list of loaded books.
     #   See the other overload for additional info.
     #   @param bookUrl [String]  Help book URL (note that syntax of filename and URL is different on most platforms).
@@ -148,6 +151,7 @@ module Wx::HTML
     
     # @overload display(x)
     #   Displays page x.
+    #   
     #   This is THE important function - it is used to display the help in application. You can specify the page in many ways:
     #   
     #   - as direct filename of HTML document
@@ -180,6 +184,7 @@ module Wx::HTML
     def display_index; end
     
     # Displays the help window, focuses search panel and starts searching.
+    # 
     # Returns true if the keyword was found. Optionally it searches through the index (mode = {Wx::HelpSearchMode::HELP_SEARCH_INDEX}), default the content (mode = {Wx::HelpSearchMode::HELP_SEARCH_ALL}).
     # 
     # <div class="wxrb-note">
@@ -200,6 +205,7 @@ module Wx::HTML
     
     # Sets whether the help frame should prevent application from exiting if it's the only remaining top level window.
     # 
+    # 
     # @see Wx::App#set_exit_on_frame_delete
     # @param enable [Boolean]  If true, the application will not quit unless the help frame is closed. Default is false, i.e. the application does exit if only the help window remains opened.
     # @return [void]
@@ -207,6 +213,7 @@ module Wx::HTML
     alias_method :should_prevent_app_exit=, :set_should_prevent_app_exit
     
     # Sets the path for storing temporary files - cached binary versions of index and contents files.
+    # 
     # These binary forms are much faster to read. Default value is empty string (empty string means that no cached data are stored). Note that these files are not deleted when program exits.
     # Once created these cached files will be used in all subsequent executions of your application. If cached files become older than corresponding <code>".hhp"</code> file (e.g. if you regenerate documentation) it will be refreshed.
     # @param path [String] 
@@ -215,6 +222,7 @@ module Wx::HTML
     alias_method :temp_dir=, :set_temp_dir
     
     # Sets format of title of the frame.
+    # 
     # Must contain exactly one "%s" (for title of displayed HTML page).
     # @param format [String] 
     # @return [void]
@@ -222,6 +230,7 @@ module Wx::HTML
     alias_method :title_format=, :set_title_format
     
     # Associates the config object with the controller.
+    # 
     # If there is associated config object, {Wx::HTML::HtmlHelpController} automatically reads and writes settings (including {Wx::HTML::HtmlWindow}'s settings) when needed. The only thing you must do is create {Wx::Config} object and call {Wx::HTML::HtmlHelpController#use_config}.
     # If you do not use {Wx::HTML::HtmlHelpController#use_config}, {Wx::HTML::HtmlHelpController} will use the default {Wx::Config} object if available (for details see {Wx::ConfigBase::Get} and {Wx::ConfigBase::Set}).
     # @param config [Wx::ConfigBase] 
@@ -241,6 +250,7 @@ module Wx::HTML
     alias_method :help_window, :get_help_window
     
     # Set the help window to be managed by this controller.
+    # 
     # This makes it possible to have a help window that might not be in a {Wx::HtmlHelpFrame} or dialog but is embedded in some other window in the application. Be sure to use the {Wx::HTML::HF_EMBEDDED} style in this case.
     # @param helpWindow [Wx::HTML::HtmlHelpWindow] 
     # @return [void]
@@ -248,12 +258,14 @@ module Wx::HTML
     alias_method :help_window=, :set_help_window
     
     # Displays the section as a popup window using a context id.
+    # 
     # Returns false if unsuccessful or not implemented.
     # @param contextId [Integer] 
     # @return [Boolean]
     def display_context_popup(contextId) end
     
     # Displays the text in a popup window, if possible.
+    # 
     # Returns false if unsuccessful or not implemented.
     # @param text [String] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
@@ -261,12 +273,14 @@ module Wx::HTML
     def display_text_popup(text, pos) end
     
     # Returns the window to be used as the parent for the help window.
+    # 
     # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
     # @return [Wx::Window]
     def get_parent_window; end
     alias_method :parent_window, :get_parent_window
     
     # Initializes the help instance with a help filename.
+    # 
     # Does not invoke the help viewer. This must be called directly after the help instance object is created and before any attempts to communicate with the viewer.
     # You may omit the file extension and a suitable one will be chosen. For {Wx::HTML::HtmlHelpController}, the extensions zip, htb and hhp will be appended while searching for a suitable file. For WinHelp, the hlp extension is appended.
     # @param file [String] 
@@ -274,11 +288,13 @@ module Wx::HTML
     def init(file) end
     
     # Overridable member called when this application's viewer is quit by the user.
+    # 
     # This does not work for all help controllers.
     # @return [void]
     def on_quit; end
     
     # Set the parameters of the frame window.
+    # 
     # For {Wx::HTML::HtmlHelpController}, titleFormat specifies the title string format (with s being replaced by the actual page title) and size and position specify the geometry of the frame.
     # For all other help controllers this function has no effect.
     # Finally, newFrameEachTime is always ignored currently.
@@ -290,6 +306,7 @@ module Wx::HTML
     def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
     
     # Sets the window to be used as the parent for the help window.
+    # 
     # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
     # @param parentWindow [Wx::Window] 
     # @return [void]
@@ -297,6 +314,7 @@ module Wx::HTML
     alias_method :parent_window=, :set_parent_window
     
     # Sets detailed viewer information.
+    # 
     # So far this is only relevant to {Wx::ExtHelpController}. Some examples of usage:
     # 
     # ```ruby

data/lib/wx/doc/gen/html/html_help_data.rb

@@ -7,6 +7,7 @@
 module Wx::HTML
 
   # This class is used by {Wx::HTML::HtmlHelpController} and {Wx::HtmlHelpFrame} to access HTML help items.
+  # 
   # It is internal class and should not be used directly - except for the case you're writing your own HTML help controller.
   # 
   # Category:  {Wx::HELP}, {Wx::HTML}
@@ -19,6 +20,7 @@ module Wx::HTML
     def initialize; end
     
     # Adds new book.
+    # 
     # book_url is URL (not filename!) of HTML help project (hhp) or ZIP file that contains arbitrary number of .hhp projects (this zip file can have either .zip or .htb extension, htb stands for "html book").
     # Returns success.
     # @param book_url [String] 
@@ -51,6 +53,7 @@ module Wx::HTML
     alias_method :index_array, :get_index_array
     
     # Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored.
+    # 
     # (This is turned off by default and you can enable this feature by setting non-empty temp dir.)
     # @param path [String] 
     # @return [void]
@@ -63,6 +66,7 @@ module Wx::HTML
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_HELP,USE_HTML
   class HtmlBookRecord < ::Object
@@ -129,6 +133,7 @@ module Wx::HTML
   # 
   # 
   # 
+  # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   # @wxrb_require USE_HELP,USE_HTML
   class HtmlHelpDataItem < ::Object