summaryrefslogtreecommitdiff
path: root/trunk/Examples/python/docstrings
diff options
context:
space:
mode:
authorWilliam S Fulton <wsf@fultondesigns.co.uk>2010-06-02 20:53:17 +0000
committerWilliam S Fulton <wsf@fultondesigns.co.uk>2010-06-02 20:53:17 +0000
commit2824b0cbb66e715490e1ef13250bd675d87b32d9 (patch)
treec3bc8d54c6d73f2b7ce08cac34172dbc9f5e5b95 /trunk/Examples/python/docstrings
parent289cfef4b4766ff266f3b1bdda8ca3a952e5a047 (diff)
downloadswig-2.0.0.tar.gz
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/tags/rel-2.0.0@12089 626c5289-ae23-0410-ae9c-e8d60b6d4f22
Diffstat (limited to 'trunk/Examples/python/docstrings')
-rw-r--r--trunk/Examples/python/docstrings/Makefile24
-rw-r--r--trunk/Examples/python/docstrings/example.cxx4
-rw-r--r--trunk/Examples/python/docstrings/example.h4
-rw-r--r--trunk/Examples/python/docstrings/example.i14
-rw-r--r--trunk/Examples/python/docstrings/runme.py6
5 files changed, 52 insertions, 0 deletions
diff --git a/trunk/Examples/python/docstrings/Makefile b/trunk/Examples/python/docstrings/Makefile
new file mode 100644
index 000000000..f25450cac
--- /dev/null
+++ b/trunk/Examples/python/docstrings/Makefile
@@ -0,0 +1,24 @@
+TOP = ../..
+SWIG = $(TOP)/../preinst-swig
+CXXSRCS = example.cxx
+TARGET = example
+INTERFACE = example.i
+LIBS = -lm
+SWIGOPT = -O
+
+all::
+ $(MAKE) -f $(TOP)/Makefile CXXSRCS='$(CXXSRCS)' SWIG='$(SWIG)' \
+ SWIGOPT='$(SWIGOPT)' \
+ TARGET='$(TARGET)' INTERFACE='$(INTERFACE)' python_cpp
+
+static::
+ $(MAKE) -f $(TOP)/Makefile CXXSRCS='$(CXXSRCS)' SWIG='$(SWIG)' \
+ SWIGOPT='$(SWIGOPT)' \
+ TARGET='mypython' INTERFACE='$(INTERFACE)' python_cpp_static
+
+clean::
+ $(MAKE) -f $(TOP)/Makefile python_clean
+ rm -f $(TARGET).py
+
+check: all
+ $(MAKE) -f $(TOP)/Makefile python_run
diff --git a/trunk/Examples/python/docstrings/example.cxx b/trunk/Examples/python/docstrings/example.cxx
new file mode 100644
index 000000000..93e65421c
--- /dev/null
+++ b/trunk/Examples/python/docstrings/example.cxx
@@ -0,0 +1,4 @@
+#include "example.h"
+
+void Foo::bar() {}
+
diff --git a/trunk/Examples/python/docstrings/example.h b/trunk/Examples/python/docstrings/example.h
new file mode 100644
index 000000000..f44dbc4d3
--- /dev/null
+++ b/trunk/Examples/python/docstrings/example.h
@@ -0,0 +1,4 @@
+class Foo {
+ public:
+ void bar();
+};
diff --git a/trunk/Examples/python/docstrings/example.i b/trunk/Examples/python/docstrings/example.i
new file mode 100644
index 000000000..15e08e641
--- /dev/null
+++ b/trunk/Examples/python/docstrings/example.i
@@ -0,0 +1,14 @@
+/* File : example.i */
+%module example
+
+%{
+#include "example.h"
+%}
+
+/* %feature("docstring") has to come before the declaration of the method to
+ * SWIG. */
+%feature("docstring") Foo::bar "No comment"
+
+/* Let's just grab the original header file here */
+%include "example.h"
+
diff --git a/trunk/Examples/python/docstrings/runme.py b/trunk/Examples/python/docstrings/runme.py
new file mode 100644
index 000000000..b6c95e613
--- /dev/null
+++ b/trunk/Examples/python/docstrings/runme.py
@@ -0,0 +1,6 @@
+# file: runme.py
+
+import example
+
+print "example.Foo.bar.__doc__ =", repr(example.Foo.bar.__doc__), "(Should be 'No comment')"
+