swig/Examples
John McFarland daad5d664d Ensure empty line before code and math blocks in doxygen pydoc
Sphinx requires an empty line before code and math blocks, whereas
doxygen does not.  This update ensures that a blank line is included
before generated code and math blocks in the pydoc output.  This is
done by post-processing the docstring line by line to check whether
any newlines need to be added.  This way, if the original doxygen
source already includes an empty line before a block, an additional
unnecessary empty line is not added.

Updating the expected test output for doxygen_basic_translate, which
now adds the necessary empty line before the code block.  Adding
further test cases to doxygen_translate_all_tags to explicitly verify
that a newline is added in the pydoc output before both code and math
blocks that appear within a paragraph.

Additionally, empty lines previously appearing at the beginning of the
generated docstrings are now removed.  This does not alter the
behavior of the tests.
2019-06-18 17:12:08 -05:00
..
android
chicken
contract
csharp
d
go Fix Go tests to run in module mode 2019-04-24 21:43:38 -07:00
guile Standardise Guile simple example 2019-02-09 14:44:33 +00:00
java Java 9 deprecation warning fixes for test-suite and examples 2019-02-21 13:47:39 -08:00
javascript Misc. typos 2018-05-17 10:04:23 -04:00
lua Misc. typos 2018-05-17 10:04:23 -04:00
modula3
mzscheme Mzscheme out of source examples fixes 2019-02-09 17:14:46 +00:00
ocaml Correct ocaml dynamic targets 2019-03-26 21:24:00 +00:00
octave Misc. typos 2018-05-17 10:04:23 -04:00
perl5 Misc. typos 2018-05-17 10:04:23 -04:00
php Fix php pragmas example include path 2019-05-09 07:35:24 +01:00
pike
python The Python module import logic has changed to stop obfuscating real ImportError problems. 2018-12-16 16:41:39 +00:00
r Revert "Merge pull request #853 from ivannp/underscores" 2016-12-22 19:47:54 +00:00
ruby Misc. typos 2018-05-17 10:04:23 -04:00
s-exp
scilab Misc. typos 2018-05-17 10:04:23 -04:00
tcl Misc. typos 2018-05-17 10:04:23 -04:00
test-suite Ensure empty line before code and math blocks in doxygen pydoc 2019-06-18 17:12:08 -05:00
xml
index.html
Makefile.in Fix Go tests to run in module mode 2019-04-24 21:43:38 -07:00
README

SWIG Examples

The subdirectories of "Examples" named after SWIG's language backends
contain a number of simple examples that are primarily used for testing.

The file 'index.html' is the top of a hyperlinked document that
contains information about all of the examples along with various
notes related to each example.

Note: All of the examples rely upon the Makefile in this directory.
You may need to edit it to reflect the configuration of your machine
in case the configure script guesses incorrect settings.


*** Special note concerning C++ ***

The configure script is currently unable to handle all of the possible
options for producing dynamically loadable C++ extensions.  Here are
the rules of thumb for making C++ work:

 -  Try using the C++ as the linker for the shared library.  For example:

         g++ -shared $(OBJS) -o module.so

 -  If that doesn't work, you may need to explicitly link against some
    kind of C++ runtime library.  For example:

         ld -G $(OBJS) -L/opt/SUNWspro/lib -lCrun -o module.so

    This can be set by modifying the setting of CPP_DLLIBS in the
    Makefile.


*** Special note for SWIG Maintainers ***

When you add an example, consider arranging for the example to be also
useful as part of the SWIG testing framework.  To do this, include in
the example makefile a target "check" ("check: all" is sufficient for a
first pass), and add an invocation to ../Makefile.in under target
"check-examples" (or whatever is appropriate).  Later, we can add or
expand the actions under target "check" to do more in-depth testing.