wxruby3 0.9.0 → 0.9.2

data/rakelib/lib/director/tree_ctrl.rb

@@ -17,13 +17,31 @@ module WXRuby3
       include Typemap::TreeItemId
 
       def setup
-        spec.post_processors << :fixtreectrl
         spec.items.replace %w[wxTreeCtrl treebase.h]
         spec.override_inheritance_chain('wxTreeCtrl', %w[wxControl wxWindow wxEvtHandler wxObject])
         # mixin WithImages
         spec.include_mixin 'wxTreeCtrl', 'Wx::WithImages'
         spec.ignore('operator!=', 'operator==')
         spec.include 'wx/dirctrl.h'
+        # Use a custom interface class to work around the wxTreeCtrl::SortItems/OnCompareItems issue
+        # without having to patch the SWIG director class
+        spec.add_header_code <<~__HEREDOC
+          class WxRubyTreeCtrl : public wxTreeCtrl
+          {
+          public:
+            WxRubyTreeCtrl() : wxTreeCtrl() {}
+            WxRubyTreeCtrl(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition,
+		                       const wxSize& size = wxDefaultSize, long style = wxTR_DEFAULT_STYLE, 
+                           const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTreeCtrlNameStr)
+              : wxTreeCtrl(parent, id, pos, size, style, validator, name)
+            {}
+            virtual ~WxRubyTreeCtrl() {}
+          private:
+            DECLARE_DYNAMIC_CLASS(WxRubyTreeCtrl);
+          };
+          IMPLEMENT_DYNAMIC_CLASS(WxRubyTreeCtrl,  wxTreeCtrl);          
+          __HEREDOC
+        spec.use_class_implementation('wxTreeCtrl', 'WxRubyTreeCtrl')
         # These only differ from SetXXXList in the way memory ownership is
         # transferred. So only support the version that won't leak on wxRuby.
         spec.ignore %w[
@@ -57,7 +75,7 @@ module WXRuby3
           wxTreeCtrl::GetFocusedItem
           wxTreeCtrl::GetSelection
           ]
-        if Config.instance.features_set?('wxHAS_LAST_VISIBLE')
+        if Config.instance.features_set?('HAS_LAST_VISIBLE')
           spec.no_proxy 'wxTreeCtrl::GetLastVisible'
         end
         # simply a nuisance to support
@@ -66,7 +84,7 @@ module WXRuby3
           wxTreeCtrl::EndEditLabel
           ]
         # for now, ignore this version as the added customization features
-        # do not work as yet and may cause us more trouble than it's worth
+        # work only on WXMSW as yet and may cause us more trouble than it's worth
         spec.ignore 'wxTreeCtrl::EditLabel'
         # add simplified non-virtual version
         spec.add_extend_code 'wxTreeCtrl', <<~__HEREDOC
@@ -76,10 +94,9 @@ module WXRuby3
             (void)self->EditLabel(item);
           }
           __HEREDOC
-        if [:wxmsw, :wxqt].include?(Config.instance.wx_port)
-          spec.ignore('wxTreeCtrl::SetButtonsImageList')
-          spec.ignore('wxTreeCtrl::GetButtonsImageList')
-        end
+        spec.ignore_unless(Config::AnyOf.new(*%w[WXGTK WXOSX]),
+                           'wxTreeCtrl::SetButtonsImageList',
+                           'wxTreeCtrl::GetButtonsImageList')
         # these reimplemented window base methods need to be properly wrapped but
         # are missing from the XML docs
         spec.extend_interface('wxTreeCtrl',
@@ -371,47 +388,4 @@ module WXRuby3
 
   end # class Director
 
-  module SwigRunner
-    class Processor
-
-      # special post-processor for TreeCtrl
-      class Fixtreectrl < Processor
-
-        def run
-          director_found = false
-          update_source do |line|
-            # Ugly: special fixes for TreeCtrl - these macros and extra funcs
-            # are needed to allow user-defined sorting to work
-            # default ctor needed for Swig::Director
-            if line["Director(VALUE self) : swig_self(self), swig_disown_flag(false)"]
-              line = "    Director() { } // added by fixmodule.rb \n" + line
-            end
-            if line["SwigDirector_wxTreeCtrl::SwigDirector_wxTreeCtrl(VALUE self)"]
-              line = "IMPLEMENT_DYNAMIC_CLASS(SwigDirector_wxTreeCtrl,  wxTreeCtrl);\n" + line
-              director_found = true
-            end
-
-            line
-          end
-          if director_found
-            # We also need to tweak the header file
-            update_header do |line|
-              if line.strip == 'public:'
-                line << "\nSwigDirector_wxTreeCtrl() {};"
-              elsif /\A};/ =~ line
-                line = <<~__HEREDOC
-                  private:
-                  DECLARE_DYNAMIC_CLASS(SwigDirector_wxTreeCtrl);
-                  };
-                  __HEREDOC
-              end
-              line
-            end
-          end
-        end
-      end # class Fixtreectrl
-
-    end
-  end
-
 end # module WXRuby3

data/rakelib/lib/director/variant.rb

@@ -227,7 +227,7 @@ module WXRuby3
             $1 = rb_obj_is_kind_of($input, rb_const_get(mWxPG, var_ColourPropertyValue_id()));
           __CODE
         end
-        if Config.instance.features_set?('wxUSE_LONGLONG')
+        if Config.instance.features_set?('USE_LONGLONG')
           # wxLongLong mapping to be considered before considering 'long' (see typecheck precedence)
           spec.map 'wxLongLong' => 'Integer' do
             map_in code: <<~__CODE

data/rakelib/lib/director/window.rb

@@ -68,7 +68,6 @@ module WXRuby3
           spec.ignore [
             'wxWindow::TransferDataFromWindow',
             'wxWindow::TransferDataToWindow',
-            'wxWindow::GetAccessible',
             'wxWindow::PopEventHandler',
             'wxWindow::SetConstraints',
             'wxWindow::GetHandle',
@@ -110,10 +109,15 @@ module WXRuby3
             spec.ignore 'wxWindow::EnableTouchEvents'
           end
           if Config.instance.wx_version >= '3.3.0'
-            spec.ignore('wxWindow::MSWDisableComposited') unless Config.instance.features_set?('__WXMSW__')
+            spec.ignore_unless('WXMSW', 'wxWindow::MSWDisableComposited')
           end
-          spec.ignore('wxWindow::SetAccessible') unless Config.instance.features_set?('wxUSE_ACCESSIBILITY')
-          spec.ignore(%w[wxWindow::RegisterHotKey wxWindow::UnregisterHotKey]) unless Config.instance.features_set?('wxUSE_HOTKEY')
+          if Config.instance.features_set?('USE_ACCESSIBILITY')
+            spec.disown 'wxAccessible *accessible'
+          else
+            spec.ignore('wxWindow::SetAccessible',
+                        'wxWindow::GetAccessible')
+          end
+          spec.ignore_unless('USE_HOTKEY', %w[wxWindow::RegisterHotKey wxWindow::UnregisterHotKey])
           spec.ignore('wxWindow::SetSize(int, int)') # not useful as the wxSize variant will also accept an array
           spec.swig_import %w{
             swig/classes/include/wxObject.h
@@ -189,7 +193,22 @@ module WXRuby3
           
               return do_paint_buffered(self);
             }
-          __HEREDOC
+
+            VALUE each_child() 
+            {
+              const wxWindowList& child_list = self->GetChildren();
+              VALUE rc = Qnil;
+              wxWindowList::compatibility_iterator node = child_list.GetFirst();
+              while (node)
+              {
+                wxObject *child = node->GetData();
+                VALUE rb_child = wxRuby_WrapWxObjectInRuby(child);
+                rc = rb_yield(rb_child);
+                node = node->GetNext();
+              }
+              return rc;
+            }
+            __HEREDOC
           spec.override_events 'wxWindow', 'EVT_ACTIVATE' => ['EVT_ACTIVATE', 0, 'wxActivateEvent']
         when 'wxNonOwnedWindow'
           spec.no_proxy('wxNonOwnedWindow')

data/rakelib/lib/director.rb

@@ -94,7 +94,7 @@ module WXRuby3
 
       def each_package(&block)
         packages.each_value do |pkg|
-          pkg.each_package(&block) if Config.instance.features_set?(*pkg.required_features)
+          pkg.each_package(&block) if Package.full_docs? || Config.instance.features_set?(*pkg.required_features)
         end
       end
 
@@ -269,7 +269,7 @@ module WXRuby3
     end
 
     def handle_item_ignore(defmod, fullname, ignore, ignoredoc)
-      action = ignore ? 'ignore' : 'regard'
+      action = (ignore==false) ? 'regard' : 'ignore'
       # find the item
       item = defmod.find_item(fullname)
       if item
@@ -361,8 +361,8 @@ module WXRuby3
       # extract the module definitions
       defmod = Extractor.extract_module(spec.package, spec.module_name, spec.name, spec.items, gendoc: gendoc)
       # handle ignores
-      spec.ignores.each_pair do |fullname, ignoredoc|
-        handle_item_ignore(defmod, fullname, true, ignoredoc)
+      spec.ignores.each_pair do |fullname, ignore_spec|
+        handle_item_ignore(defmod, fullname, ignore_spec[:ignore], ignore_spec[:ignore_doc])
       end
       # handle regards
       spec.regards.each_pair do |fullname, regarddoc|

data/rakelib/lib/extractor/function.rb

@@ -75,14 +75,14 @@ module WXRuby3
         "self.#{rb_method_name(rb_name || name)}"
       end
 
-      def rb_doc(xml_trans, type_maps)
-        ovls = all.select {|m| !m.docs_ignored && !m.deprecated }
-        ovl_docs = ovls.collect { |mo| mo.rb_doc_decl(xml_trans, type_maps) }
-        ovl_docs.inject({}) do |docs, (name, params, doc)|
+      def rb_doc(xml_trans, type_maps, fulldocs=false)
+        ovls = all.select {|m| !m.docs_ignored(fulldocs) && !m.deprecated }
+        ovl_docs = ovls.collect { |mo| [mo]+mo.rb_doc_decl(xml_trans, type_maps) }
+        ovl_docs.inject({}) do |docs, (movl, name, params, doc)|
           if docs.has_key?(name)
-            docs[name] << [params, doc]
+            docs[name] << [movl, params, doc]
           else
-            docs[name] = [[params, doc]]
+            docs[name] = [[movl, params, doc]]
           end
           docs
         end

data/rakelib/lib/extractor.rb

@@ -182,7 +182,7 @@ module WXRuby3
         extract(element) if element
       end
 
-      attr_accessor :name, :rb_name, :ignored, :docs_ignored, :brief_doc, :detailed_doc, :deprecated, :only_for, :items
+      attr_accessor :name, :rb_name, :brief_doc, :detailed_doc, :deprecated, :only_for, :items
 
       def extra_attributes
         @extra_attributes ||= {}
@@ -221,8 +221,10 @@ module WXRuby3
           @detailed_doc = element.xpath('detaileddescription')
           if (el = @detailed_doc.at_xpath('para/onlyfor'))
             @only_for = el.text.strip.split(',').collect { |s| s.downcase }
-            @ignored = @only_for.none? { |s| Config.instance.wx_port == s.to_sym }
-            @docs_ignored = @ignored
+            unless @only_for.empty?
+              @ignored = [Config::AnyOf.new(*@only_for.collect { |s| s.upcase })] # transform to feature ids like 'WXGTK'
+              @docs_ignored = @ignored
+            end
           end
         end
       end
@@ -256,12 +258,39 @@ module WXRuby3
         end
       end
 
+      def get_ignore_val(val)
+        if val.is_a?(::Array)
+          val
+        elsif val.is_a?(Config::AnyOf) || val.is_a?(::String)
+          [val]
+        else
+          !!val
+        end
+      end
+      private :get_ignore_val
+
       def ignore(val = true, ignore_doc: nil)
-        @ignored = !!val
-        @docs_ignored = ignore_doc.nil? ? @ignored : ignore_doc
+        @ignored = get_ignore_val(val)
+        @docs_ignored = if ignore_doc.nil?
+                          @ignored
+                        else
+                          get_ignore_val(ignore_doc)
+                        end
         self
       end
 
+      def ignored
+        @ignored == true || (@ignored.is_a?(::Array) && !Config.instance.features_set?(*@ignored))
+      end
+
+      def docs_ignored(fulldocs)
+        @docs_ignored == true || (!fulldocs && @docs_ignored.is_a?(::Array) && !Config.instance.features_set?(*@docs_ignored))
+      end
+
+      def required_features_doc
+        @docs_ignored.is_a?(::Array) ? @docs_ignored : nil
+      end
+
       def find(name)
         # Locate and return an item within this item that has a matching name.
         # The name string can use a dotted notation to continue the search

data/rakelib/lib/generate/analyzer.rb

@@ -87,7 +87,7 @@ module WXRuby3
       attr_reader :director, :classdef, :class_spec_name, :class_registry
 
       def item_ignored?(item)
-        @doc_gen ? item.docs_ignored : item.ignored
+        @doc_gen ? item.docs_ignored(Director::Package.full_docs?) : item.ignored
       end
       private :item_ignored?
 
@@ -482,12 +482,17 @@ module WXRuby3
         end
       end
 
+      def item_ignored(item, doc_gen)
+        doc_gen ? item.docs_ignored(Director::Package.full_docs?) : item.ignored
+      end
+      private :item_ignored
+
       def preprocess(enum_maps, doc_gen = false)
         STDERR.puts "** Preprocessing #{module_name}" if Director.trace?
         def_items.each do |item|
           case item
           when Extractor::ClassDef
-            if !(doc_gen ? item.docs_ignored : item.ignored) &&
+            if !item_ignored(item, doc_gen) &&
                   (!item.is_template? || template_as_class?(item.name)) &&
                   !is_folded_base?(item.name)
               clsproc = ClassProcessor.new(director, item, doc_gen)
@@ -536,7 +541,7 @@ module WXRuby3
           errors = []
           warnings = []
           def_items.each do |item|
-            if Extractor::ClassDef === item && !(doc_gen ? item.docs_ignored : item.ignored) &&
+            if Extractor::ClassDef === item && !item_ignored(item, doc_gen) &&
               (!item.is_template? || template_as_class?(item.name)) &&
               !is_folded_base?(item.name)
               intf_class_name = if item.is_template? || template_as_class?(item.name)

data/rakelib/lib/generate/doc/animation_ctrl.yaml

@@ -0,0 +1,15 @@
+---
+:wxAnimationBundle:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            
+            ```ruby
+              animationCtrl = Wx::AnimationCtrl.new(parent, Wx::ID_ANY)
+              animations = Wx::AnimationBundle.new 
+              animations.add("throbber.gif")
+              animations.add("throbber_2x.gif")
+              animationCtrl.play if animationCtrl.set_animation(animations)
+            ```

data/rakelib/lib/generate/doc/busy_info.yaml

@@ -47,8 +47,6 @@
           
             but take care to not cause undesirable re-entrance when doing it (see {Wx::App#yield} for more details). The simplest way to do it is to use {Wx::WindowDisabler} class as illustrated in the above example.
             Note that a {Wx::BusyInfo} is always built with the {Wx::STAY_ON_TOP} window style (see {Wx::Frame} window styles for more info).
-            
-            ===
           
             Category:  Common Dialogs
           

data/rakelib/lib/generate/doc/clipboard.yaml

@@ -37,7 +37,5 @@
             clipboard managers will automatically flush the clipboard after each new piece of data is added, while others 
             will not. The {Wx::Clipboard#flush} function will force the clipboard manager to flush the data.
             
-            === 
-            
             Category:  Clipboard and Drag & Drop
             @see  Wx::DataObject 

data/rakelib/lib/generate/doc/cursor.yaml

@@ -13,8 +13,6 @@
             the cursor for a window, as in X, rather than to set it globally as in MS Windows, although a global 
             {set_cursor} function is also available for MS Windows use.
             
-            === 
-            
             Category:  Graphics Device Interface (GDI)
             Predefined objects/pointers:
             - {Wx::NULL_CURSOR}

data/rakelib/lib/generate/doc/events.yaml

@@ -57,6 +57,16 @@
               if event.get_modifiers == Wx::KeyModifier::MOD_CONTROL
                 # ... handle Ctrl-XXX ...
             ```
+:wxKeyEvent.GetRawKeyCode:
+  :detail:
+    :post:
+      - :pattern: !ruby/regexp /,\s+use\s+\#ifdef\s+\{Wx::HAS_RAW_KEY_CODES\}.*available\./
+        :subst: '.'
+:wxKeyEvent.GetRawKeyFlags:
+  :detail:
+    :post:
+      - :pattern: !ruby/regexp /,\s+use\s+\#ifdef\s+\{Wx::HAS_RAW_KEY_CODES\}.*available\./
+        :subst: '.'
 :wxMouseEvent.GetModifiers:
   :detail:
     :pre:
@@ -114,10 +124,6 @@
                   vb_pt = get_view_start # Top left corner of client
                 
                   Wx::RegionIterator.for_region(get_update_region) do |region_it|
-            
-                    int vX,vY,vW,vH                 
-                    wxRegionIterator upd(GetUpdateRegion()) # get the update rect list
-                
                     region_it.each do |rct|
                       # rct == Dimensions of client area to repaint in pixels
                 

data/rakelib/lib/generate/doc/panel.yaml

@@ -0,0 +1,7 @@
+---
+:wxPanel:
+  :detail:
+    :pre:
+      :simplesect:
+        - :pattern: !ruby/regexp /Tab\s+traversal\s+is\s+implemented.*/
+          :replace: ''

data/rakelib/lib/generate/doc/static_box.yaml

@@ -18,6 +18,14 @@
             
               end
             ```
+    :post:
+      - :pattern: !ruby/regexp /,\s+use\s+\{Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX\}.*compile-time\./
+        :subst: '.'
+:wxStaticBox.Create:
+  :detail:
+    :post:
+      - :pattern: !ruby/regexp /,\s+use\s+\{Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX\}.*compile-time\./
+        :subst: '.'
 :wxStaticBox.Enable:
   :detail:
     :pre:

data/rakelib/lib/generate/doc/xml_resource.yaml

@@ -11,6 +11,9 @@
                 Wx.log_error("Couldn't load resources!")
               end
             ```
+    :post:
+      - :pattern: !ruby/regexp /If\s+\{Wx::USE_FILESYS\}.*\)\./
+        :subst: 'If {Wx::Setup::USE_FILESYSTEM} is enabled, this method understands {Wx::FileSystem} URLs.'
 :wxXmlResource.LoadDialog:
   :detail:
     :pre:

data/rakelib/lib/generate/doc.rb

@@ -151,8 +151,10 @@ module WXRuby3
       def text_to_doc(node)
         text = node.text
         # handle left-over doxygen tags
+        text.gsub!(/#(\w)/, '\#\1')
         text.gsub!(/@(end)?code/, '')
-        text.gsub!('@subsection', '==')
+        text.gsub!('@subsection', '##')
+        text = '' if text.strip == '##' # no empty headings
         text.gsub!('@remarks', '')
         text.gsub!(/@see.*\n/, '')
         text.gsub!('@ref', '')
@@ -172,7 +174,7 @@ module WXRuby3
               end
             end
           end
-          text.gsub!(/WX(K_[A-Z]+)/) { "{Wx::#{$1}}"}
+          text.gsub!(/WX(K_[A-Z]+)/) { "{Wx::KeyCode::#{$1}}"}
         end
         if event_section?
           case text
@@ -224,6 +226,10 @@ module WXRuby3
         end
       end
 
+      def onlyfor_to_doc(node)
+        '' # handled elsewhere
+      end
+
       def simplesect_to_doc(node)
         case node['kind']
         when 'since' # get rid of 'Since' notes
@@ -233,6 +239,22 @@ module WXRuby3
             @see_list.concat node_to_doc(node).split(',')
           end
           ''
+        when 'note'
+          <<~__NOTE
+
+            <div class="wxrb-note">
+            <b>Note:</b>
+            <p>#{node_to_doc(node)}</p>
+            </div>
+          __NOTE
+        when 'remark'
+          <<~__NOTE
+
+            <div class="wxrb-remark">
+            <b>Remark:</b>
+            <p>#{node_to_doc(node)}</p>
+            </div>>
+          __NOTE
         else
           node_to_doc(node)
         end
@@ -280,7 +302,9 @@ module WXRuby3
 
       def _ident_str_to_doc(s, ref_scope = nil)
         return s if no_idents?
-        return s if %w[wxRuby wxMSW wxOSX wxGTK wxX11].any? { |w| s.start_with?(w) }
+        return s if s.start_with?('wxRuby')
+        return 'WXOSX' if s.start_with?('wxMac')
+        return s.sub(/\Awx/, 'WX') if %w[wxMSW wxOSX wxGTK wxX11 wxUNIVERSAL].any? { |w| s.start_with?(w) }
         nmlist = s.split('::')
         nm_str = nmlist.shift.to_s
         constnm = rb_wx_name(nm_str)
@@ -343,6 +367,7 @@ module WXRuby3
             mtd = $1
             args = _arglist_to_doc($2)
           end
+          # transform the scope prefix
           if DocGenerator.constants_xref_db.has_key?(constnm)
             constnm = "#{DocGenerator.constants_xref_db[constnm]['mod']}::#{constnm}"
           elsif DocGenerator.constants_xref_db.has_key?(rb_constant_name(nm_str))
@@ -355,8 +380,18 @@ module WXRuby3
             known = false
             constnm = "Wx::#{constnm}"
           end
+          # transform and append the element id
           if mtd.nil?
-            if DocGenerator.constants_xref_db.has_key?(rb_wx_name(itmnm)) || !_is_method?(itmnm, nm_str)
+            if DocGenerator.constants_xref_db.has_key?(rb_wx_name(itmnm))
+              itmnm = rb_wx_name(itmnm)
+              # in case of enum constants the documented scope most likely omits the enum class
+              # which we want for correct linking for wxRuby
+              if DocGenerator.constants_xref_db[itmnm]['mod'].start_with?("#{constnm}::")
+                ["#{DocGenerator.constants_xref_db[itmnm]['mod']}::#{rb_wx_name(itmnm)}", known]
+              else
+                ["#{constnm}::#{rb_wx_name(itmnm)}", known]
+              end
+            elsif !_is_method?(itmnm, nm_str)
               ["#{constnm}::#{rb_wx_name(itmnm)}", known]
             else
               sep = _is_static_method?(nm_str, itmnm) ? '.' : '#'
@@ -391,14 +426,15 @@ module WXRuby3
 
       # transform all titles
       def title_to_doc(node)
-        "== #{node.text}\n"
+        "## #{node.text}\n"
       end
 
       def heading_to_doc(node)
         lvl = 1+(node['level'] || '1').to_i
         txt = node_to_doc(node)
         event_section(/Events emitted by this class|Events using this class/i =~ txt)
-        "#{'=' * lvl} #{txt}"
+        txt.strip!
+        txt.empty? ? txt : "#{'#' * lvl} #{txt}"
       end
 
       # transform all itemizedlist
@@ -671,6 +707,36 @@ module WXRuby3
 
     protected
 
+    def to_feature_text(feat)
+      if Config::AnyOf === feat
+        feat.features.collect { |f| f.is_a?(::Array) ? f.join('&') : f }.join('|')
+      else
+        feat
+      end
+    end
+    private :to_feature_text
+
+    def gen_item_requirements(fdoc, item)
+      if item.required_features_doc
+        fdoc.doc.puts '@wxrb_require ' + item.required_features_doc.collect(&->(feat){ to_feature_text(feat) }).join(',')
+      end
+    end
+
+    def has_class_requirements?
+      !(ifspec.requirements.empty? && ifspec.package.required_features.empty?)
+    end
+
+    def get_class_requirements
+      ifspec.requirements + ifspec.package.required_features.to_a
+    end
+    private :get_class_requirements
+
+    def gen_class_requirements(fdoc)
+      if has_class_requirements?
+        fdoc.doc.puts '@wxrb_require ' + get_class_requirements.collect(&->(feat){ to_feature_text(feat) }).join(',')
+      end
+    end
+
     def get_constant_doc(const)
       @xml_trans.to_doc(const.brief_doc, item: const)
     end
@@ -707,6 +773,7 @@ module WXRuby3
 
     def gen_enum_doc(fdoc, enumname, enumdef, enum_table)
       fdoc.doc.puts get_enum_doc(enumdef)
+      gen_class_requirements(fdoc)
       fdoc.puts "class #{enumname} < Wx::Enum"
       fdoc.puts
       fdoc.indent do
@@ -723,7 +790,7 @@ module WXRuby3
 
     def gen_constants_doc(fdoc)
       xref_table = package.all_modules.reduce(DocGenerator.constants_db) { |db, mod| db[mod] }
-      def_items.select {|itm| !itm.docs_ignored }.each do |item|
+      def_items.select {|itm| !itm.docs_ignored(Director::Package.full_docs?) }.each do |item|
         case item
         when Extractor::GlobalVarDef
           unless no_gen?(:variables)
@@ -762,22 +829,24 @@ module WXRuby3
     end
 
     def get_function_doc(func)
-      func.rb_doc(@xml_trans, type_maps)
+      func.rb_doc(@xml_trans, type_maps, Director::Package.full_docs?)
     end
 
     def gen_functions_doc(fdoc)
-      def_items.select {|itm| !itm.docs_ignored }.each do |item|
-        if Extractor::FunctionDef === item && !item.docs_ignored
+      def_items.select {|itm| !itm.docs_ignored(Director::Package.full_docs?) }.each do |item|
+        if Extractor::FunctionDef === item
           get_method_doc(item).each_pair do |name, docs|
             if docs.size>1 # method with overloads?
-              docs.each do |params, ovl_doc|
+              docs.each do |ovl, params, ovl_doc|
                 fdoc.doc.puts "@overload #{name}(#{params})"
                 fdoc.doc.indent { fdoc.doc.puts ovl_doc }
+                fdoc.doc.indent { gen_item_requirements(fdoc, ovl) }
               end
               fdoc.puts "def #{name}(*args) end"
             else
-              params, doc = docs.shift
+              mtd, params, doc = docs.shift
               fdoc.doc.puts doc
+              gen_item_requirements(fdoc, mtd)
               if params.empty?
                 fdoc.puts "def #{name}; end"
               else
@@ -797,7 +866,7 @@ module WXRuby3
     end
 
     def get_method_doc(mtd)
-      mtd.rb_doc(@xml_trans, type_maps)
+      mtd.rb_doc(@xml_trans, type_maps, Director::Package.full_docs?)
     end
 
     def get_method_head(clsdef, mtdef)
@@ -825,14 +894,16 @@ module WXRuby3
             mtd_head = get_method_head(clsdef, cm)
             get_method_doc(mtd_head).each_pair do |name, docs|
               if docs.size>1 # method with overloads?
-                docs.each do |params, ovl_doc|
+                docs.each do |ovl, params, ovl_doc|
                   fdoc.doc.puts "@overload #{name}(#{params})"
                   fdoc.doc.indent { fdoc.doc.puts ovl_doc }
+                  fdoc.doc.indent { gen_item_requirements(fdoc, ovl) }
                 end
                 fdoc.puts "def #{name}(*args) end"
               else
-                params, doc = docs.shift
+                mtd, params, doc = docs.shift
                 fdoc.doc.puts doc
+                gen_item_requirements(fdoc, mtd)
                 if params.empty?
                   fdoc.puts "def #{name}; end"
                 else
@@ -887,7 +958,7 @@ module WXRuby3
 
     def gen_class_doc(fdoc)
       const_table = package.all_modules.reduce(DocGenerator.constants_db) { |db, mod| db[mod] }
-      def_items.select {|itm| !itm.docs_ignored && Extractor::ClassDef === itm && !is_folded_base?(itm.name) }.each do |item|
+      def_items.select {|itm| !itm.docs_ignored(Director::Package.full_docs?) && Extractor::ClassDef === itm && !is_folded_base?(itm.name) }.each do |item|
         if !item.is_template? || template_as_class?(item.name)
           @xml_trans.for_class(item) do
             intf_class_name = if (item.is_template? && template_as_class?(item.name))
@@ -900,9 +971,11 @@ module WXRuby3
             fdoc.doc.puts get_class_doc(item)
             if is_mixin?(item)
               fdoc.doc.puts "\n@note  In wxRuby this is a mixin module instead of a (base) class."
+              gen_class_requirements(fdoc)
               fdoc.puts "module #{clsnm}"
             else
               fdoc.doc.puts "\n@note This class is <b>untracked</b> and should not be derived from nor instances extended!" unless is_tracked?(item)
+              gen_class_requirements(fdoc)
               basecls = ifspec.classdef_name(base_class(item, doc: true))
               fdoc.puts "class #{clsnm} < #{basecls ? basecls.sub(/\Awx/, '') : '::Object'}"
             end