Modules generated by SWIG can now have module docstrings.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@27279 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/wxPython/SWIG/swig.python-docstring.patch b/wxPython/SWIG/swig.python-docstring.patch
index b906fa289856cb8323bf15a219c9afce5708c62b..823ab15d58990513cb0cc734421fcae80032dc9c 100644 (file)
--- a/wxPython/SWIG/swig.python-docstring.patch
+++ b/wxPython/SWIG/swig.python-docstring.patch
@@ -4,18 +4,7 @@ RCS file: /cvsroot/swig/SWIG/Source/Modules/python.cxx,v
 retrieving revision 1.40
 diff -u -4 -r1.40 python.cxx
 --- Source/Modules/python.cxx  24 Jan 2004 00:25:31 -0000      1.40
-+++ Source/Modules/python.cxx  28 Apr 2004 22:20:03 -0000
-@@ -8,9 +8,9 @@
-  * Copyright (C) 1999-2000.  The University of Chicago
-  * See the file LICENSE for information on usage and redistribution.
-  * ----------------------------------------------------------------------------- */
- 
--char cvsroot_python_cxx[] = "$Header$";
-+char cvsroot_python_cxx[] = "$Header$";
- 
- #include "swigmod.h"
- 
- #include <ctype.h>
++++ Source/Modules/python.cxx  12 May 2004 19:45:20 -0000
 @@ -50,8 +50,18 @@
  static  int       have_constructor;
  static  int       have_repr;
@@ -35,7 +24,41 @@ diff -u -4 -r1.40 python.cxx
  Python Options (available with -python)\n\
       -ldflags        - Print runtime libraries to link with\n\
       -globals <name> - Set <name> used to access C global variable [default: 'cvar']\n\
-@@ -417,17 +427,25 @@
+@@ -146,8 +156,9 @@
+      *
+      * use %module(directors="1") modulename at the start of the 
+      * interface file to enable director generation.
+      */
++    String* mod_docstring = NULL;
+     {
+       Node *module = Getattr(n, "module");
+       if (module) {
+         Node *options = Getattr(module, "options");
+@@ -157,8 +168,9 @@
+           }
+           if (Getattr(options, "dirprot")) {
+           allow_dirprot();
+           }
++          mod_docstring = Getattr(options, "docstring");
+         }
+       }
+     }
+ 
+@@ -258,8 +270,13 @@
+           Printv(f_shadow,
+                  "# This file is compatible with both classic and new-style classes.\n",
+                  NIL);
+       }
++
++      if (mod_docstring && Len(mod_docstring)) {
++        Printv(f_shadow, "\n\"\"\"\n", mod_docstring, "\n\"\"\"\n", NIL);
++        Delete(mod_docstring); mod_docstring = NULL;
++      }
+       
+       Printf(f_shadow,"\nimport %s\n\n", module);
+ 
+       if (! modern) {
+@@ -417,17 +434,25 @@
     *    functions.
     * ------------------------------------------------------------ */
  
@@ -66,7 +89,7 @@ diff -u -4 -r1.40 python.cxx
    }
  
  
-@@ -441,24 +459,303 @@
+@@ -441,24 +466,303 @@
    }
  
  
@@ -169,10 +192,8 @@ diff -u -4 -r1.40 python.cxx
 +   *    it is "1" (the default) then do.  If it has some other
 +   *    value then assume it is supplied by the extension writer
 +   *    and use it directly.
-    * ------------------------------------------------------------ */
- 
--  bool have_addtofunc(Node *n) {
--    String* str = Getattr(n, "feature:addtofunc");
++   * ------------------------------------------------------------ */
++
 +  String* make_autodoc(Node *n, autodoc_t ad_type) {
 +
 +    if (ad_type == AUTODOC_CLASS)
@@ -356,8 +377,10 @@ diff -u -4 -r1.40 python.cxx
 +  /* ------------------------------------------------------------
 +   * have_pythonappend()
 +   *    Check if there is a %pythonappend directive and it has text
-+   * ------------------------------------------------------------ */
-+
+    * ------------------------------------------------------------ */
+ 
+-  bool have_addtofunc(Node *n) {
+-    String* str = Getattr(n, "feature:addtofunc");
 +  bool have_pythonappend(Node *n) {
 +    String* str = Getattr(n, "feature:pythonappend");
      return (str != NULL && Len(str) > 0);
@@ -378,7 +401,7 @@ diff -u -4 -r1.40 python.cxx
      if (*t == '{') {
        Delitem(str ,0);
        Delitem(str,DOH_END);
-@@ -1731,9 +2028,11 @@
+@@ -1731,9 +2035,11 @@
          Printf(f_shadow, modern ? "(object)" : "(_object)");
        }
        }
@@ -391,7 +414,7 @@ diff -u -4 -r1.40 python.cxx
          Printv(f_shadow,tab4,"__swig_setmethods__ = {}\n",NIL);
          if (Len(base_class)) {
            Printf(f_shadow,"%sfor _s in [%s]: __swig_setmethods__.update(_s.__swig_setmethods__)\n",tab4,base_class);
-@@ -1866,16 +2165,24 @@
+@@ -1866,16 +2172,24 @@
          Delete(pyaction);
          Printv(f_shadow,pycode,"\n",NIL);
        } else {
@@ -423,7 +446,7 @@ diff -u -4 -r1.40 python.cxx
          }
  
        }
-@@ -1890,14 +2197,22 @@
+@@ -1890,14 +2204,22 @@
    virtual int staticmemberfunctionHandler(Node *n) {
      String *symname = Getattr(n,"sym:name");
      Language::staticmemberfunctionHandler(n);
@@ -450,7 +473,7 @@ diff -u -4 -r1.40 python.cxx
                 " = staticmethod(", symname, ")\n", NIL);
  
          if (!modern) {
-@@ -1982,8 +2297,12 @@
+@@ -1982,8 +2304,12 @@
            }
  
              Printv(f_shadow, tab4, "def __init__(self, *args",
@@ -463,7 +486,7 @@ diff -u -4 -r1.40 python.cxx
              if (!modern) {
                Printv(f_shadow, tab8, "_swig_setattr(self, ", rclassname, ", 'this', ", 
                       funcCallHelper(Swig_name_construct(symname), allow_kwargs), ")\n", NIL);
-@@ -1996,10 +2315,10 @@
+@@ -1996,10 +2322,10 @@
                Printv(f_shadow, tab8, "self.this = newobj.this\n", NIL);
                Printv(f_shadow, tab8, "self.thisown = 1\n", NIL);
                Printv(f_shadow, tab8, "del newobj.thisown\n", NIL);
@@ -476,7 +499,7 @@ diff -u -4 -r1.40 python.cxx
          }
          have_constructor = 1;
        } else {
-@@ -2015,13 +2334,17 @@
+@@ -2015,13 +2341,17 @@
          } else {
  
              Printv(f_shadow_stubs, "\ndef ", symname, "(*args",
@@ -496,7 +519,7 @@ diff -u -4 -r1.40 python.cxx
          }
        }
        }
-@@ -2048,13 +2371,18 @@
+@@ -2048,13 +2378,18 @@
        Delete(pyaction);
        Printv(f_shadow,pycode,"\n", NIL);
        } else {

diff --git a/wxPython/contrib/gizmos/gizmos.i b/wxPython/contrib/gizmos/gizmos.i
index b76d189788c809a35e224380c5d45749bb52e195..d35cb4f0be27bd18f8bf413c3f2da1d8d514cbec 100644 (file)
--- a/wxPython/contrib/gizmos/gizmos.i
+++ b/wxPython/contrib/gizmos/gizmos.i
@@ -10,7 +10,12 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module gizmos
+%define DOCSTRING
+"Various *gizmo* classes: `DynamicSashWindow`, `EditableListBox`,
+`LEDNumberCtrl`, `TreeListCtrl`, etc."
+%enddef
+
+%module(docstring=DOCSTRING) gizmos
 
 
 %{

diff --git a/wxPython/contrib/glcanvas/glcanvas.i b/wxPython/contrib/glcanvas/glcanvas.i
index 8e1596eecc0cf3b6a5f3ec35f9c30cfaf4a1386e..9892e2751a827d27cf0e394b3971a561fc69d9de 100644 (file)
--- a/wxPython/contrib/glcanvas/glcanvas.i
+++ b/wxPython/contrib/glcanvas/glcanvas.i
@@ -11,7 +11,10 @@
 /////////////////////////////////////////////////////////////////////////////
 
 
-%module glcanvas
+%define DOCSTRING
+"`GLCanvas` provides an OpenGL Context on a `wx.Window`."
+%enddef
+%module(docstring=DOCSTRING) glcanvas
 
 %{
 #include "wx/wxPython/wxPython.h"

diff --git a/wxPython/contrib/ogl/ogl.i b/wxPython/contrib/ogl/ogl.i
index 8ac8c73b46f05488c0798b4bd54d407af98fdbf6..b0fe5ede3ab247f572a0088d05072e326d910a21 100644 (file)
--- a/wxPython/contrib/ogl/ogl.i
+++ b/wxPython/contrib/ogl/ogl.i
@@ -10,8 +10,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-
-%module ogl
+%define DOCSTRING
+"The Object Graphics Library provides for simple drawing and manipulation
+of 2D objects."
+%enddef
+%module(docstring=DOCSTRING) ogl
 
 %{
 #include "wx/wxPython/wxPython.h"

diff --git a/wxPython/contrib/stc/stc.i b/wxPython/contrib/stc/stc.i
index 51fa9b6860ac9d738bfa71fd63c842027ee414ee..e86434b8f06ca0249b1def7f9585aaa159774d70 100644 (file)
--- a/wxPython/contrib/stc/stc.i
+++ b/wxPython/contrib/stc/stc.i
@@ -10,7 +10,12 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module stc
+%define DOCSTRING
+"The `StyledTextCtrl` provides a text editor that can used as a syntax
+highlighting source code editor, or similar.  Lexers for several programming
+languages are built-in."
+%enddef
+%module(docstring=DOCSTRING) stc
 
 
 %{

diff --git a/wxPython/contrib/xrc/xrc.i b/wxPython/contrib/xrc/xrc.i
index f7f990aed27c2bb6a71af0516d92c08ea7c9a8d2..af3ca653f60cee78dd9da10f45a249ad81dab3cd 100644 (file)
--- a/wxPython/contrib/xrc/xrc.i
+++ b/wxPython/contrib/xrc/xrc.i
@@ -10,7 +10,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module xrc
+%define DOCSTRING
+"The `XmlResource` class allows program resources defining menus, layout of
+controls on a panel, etc."
+%enddef
+%module(docstring=DOCSTRING) xrc
 
 
 %{

diff --git a/wxPython/src/calendar.i b/wxPython/src/calendar.i
index 07364284c1e8c2e7c30d42e11052069e67c73d54..f3154a5a75a2c7492d1bbb31fd34035b90721b29 100644 (file)
--- a/wxPython/src/calendar.i
+++ b/wxPython/src/calendar.i
@@ -10,7 +10,10 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module calendar
+%define DOCSTRING
+"Classes for an interactive Calendar control."
+%enddef
+%module(docstring=DOCSTRING) calendar
 
 
 %{
@@ -184,12 +187,13 @@ Window Styles
     CAL_SEQUENTIAL_MONTH_SELECTION   Use alternative, more compact,
                                      style for the month and year
                                      selection controls.
+    ==============================   ============================
 
 The default calendar style is CAL_SHOW_HOLIDAYS.
 
 Events
 -------
-    ===========================    ==============================
+    =============================  ==============================
     EVT_CALENDAR                   A day was double clicked in the
                                    calendar.
     EVT_CALENDAR_SEL_CHANGED       The selected date changed.
@@ -198,6 +202,7 @@ Events
     EVT_CALENDAR_YEAR              The selected year changed.
     EVT_CALENDAR_WEEKDAY_CLICKED   User clicked on the week day
                                    header
+    =============================  ==============================
 
 Note that changing the selected date will result in one of
 EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED

diff --git a/wxPython/src/grid.i b/wxPython/src/grid.i
index c6b08677274920662bfa72e813ea25bf8138dc8c..0d0f37e65bc741deee14837af745f682be763363 100644 (file)
--- a/wxPython/src/grid.i
+++ b/wxPython/src/grid.i
@@ -10,7 +10,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module grid
+%define DOCSTRING
+"Classes for implementing a spreadsheet-like control."
+%enddef
+%module(docstring=DOCSTRING) grid
+
 
 %{
 #include "wx/wxPython/wxPython.h"

diff --git a/wxPython/src/html.i b/wxPython/src/html.i
index 5dcc2c635aad189207825790188d7415ec07b1d5..412fcb3b507600b610138e877f20b9e6cd916c30 100644 (file)
--- a/wxPython/src/html.i
+++ b/wxPython/src/html.i
@@ -10,8 +10,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+%define DOCSTRING
+"Classes for a simple HTML rendering window, HTML Help Window, etc."
+%enddef
 
-%module html
+%module(docstring=DOCSTRING) html
 
 %{
 #include "wx/wxPython/wxPython.h"

diff --git a/wxPython/src/wizard.i b/wxPython/src/wizard.i
index 6fd84dff2ecbaa484db3ff3490ee31620a06722c..03862c5cc9d04cde2ed8856f22653ebbedc08194 100644 (file)
--- a/wxPython/src/wizard.i
+++ b/wxPython/src/wizard.i
@@ -10,7 +10,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-%module wizard
+%define DOCSTRING
+"`Wizard` is a dialog class that guides the user through a sequence of steps,
+or pages."
+%enddef
+%module(docstring=DOCSTRING) wizard
 
 %{
 #include "wx/wxPython/wxPython.h"