Commit graph

31 commits

Author SHA1 Message Date
William S Fulton
b0a42e38e7 Revert "JAVA_HOME nad tools.jar not needed for Java testing"
This reverts commit 7373b99079.

Seems to be needed for older jdks - needs some more work, as the
classpath used is not correct for jdk9.
2018-06-09 00:40:26 +01:00
William S Fulton
7373b99079 JAVA_HOME nad tools.jar not needed for Java testing
tools.jar doesn't seem to be needed (in jdk9 anyway), so removing it.
2018-06-08 19:12:39 +01:00
William S Fulton
b189fb9456 Fix missing return value in doxygen test 2018-06-07 18:52:25 +01:00
William S Fulton
ac85784a76 Doxygen source rename
Source/DoxygenTranslator/src directory is renamed Source/Doxygen
Renamed files in this directory to short names using lowercase as is the
convention for the rest of the SWIG source.
C++ extension is also .cxx like other SWIG source code.

I used doxy as the prefix for most file renames because without this
Doxygen/parser.* would be easily confused with CParse/parser.* so
Doxygen/doxyparser.* is renamed from DoxygenTranslator/src/DoxygenParser.*
2018-05-26 12:52:52 +01:00
William S Fulton
fdade90ac8 Doxygen html tweaks 2018-05-25 07:56:45 +01:00
William S Fulton
4cdca98709 Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
William S Fulton
62814e4ab7 Fixes to makechap.py to detect ill-formed headers 2018-05-25 07:56:44 +01:00
William S Fulton
a1b1ba105b html fixes for Doxygen 2018-05-25 07:56:44 +01:00
William S Fulton
73736c3b89 Doxygen html documentation updates and corrections 2018-05-25 07:56:44 +01:00
Vadim Zeitlin
751f617aac Add support for doxygen:alias feature
This allows to replace non-standard Doxygen commands with some (fixed) text
instead of just ignoring them, as was already possible with the feature
doxygen:ignore.
2017-02-01 02:20:47 +01:00
Vadim Zeitlin
14b28f5923 Use slash, not backslash, in "C/C++" in the documentation
No real changes, but using backslashes here was really too weird.
2017-01-20 17:08:38 +01:00
Vadim Zeitlin
0fa55e4e80 Replace literal "<" with "&lt;" in HTML documentation
Even though browsers manage to display unpaired "<"s correctly, using them is
still wrong and they confuse other tools, e.g. syntax highlighting in the
editors.
2017-01-20 17:06:20 +01:00
Vadim Zeitlin
2b7bf3c850 Fix broken link to java.sun.com in Doxygen documentation
Link to the reference documentation of Javadoc at oracle.com instead, it is
more useful than the overview article (which can still be found on Oracle web
site searching for its title).
2017-01-09 13:29:03 +01:00
Vadim Zeitlin
05b5ed11bc Add a possibility to flexibly ignore custom Doxygen tags.
Add %feature("doxygen:ignore:<command>") implementation, documentation and
test case.

This feature allows to use custom tags in C++ Doxygen comments for
C++-specific things that don't make sense in the context of the target
language and also allows to insert contents specific to the target language in
the C++ comments using (different) custom commands, which is very useful in
practice to explain the particularities of the API wrappers.
2014-09-11 01:39:42 +02:00
Vadim Zeitlin
a1ae3a4344 Describe Doxygen-specific %features in a single place.
Put them all in a single table instead of describing doxygen:notranslate
separately for Java and Python when it does the same thing for both.

And while doxygen:nolinkranslate and doxygen:nostripparams are currently
Java-specific, it probably won't remain this way and these features would
either be made to work for Python as well or, perhaps, removed entirely.
2014-09-03 17:28:23 +02:00
Vadim Zeitlin
dd4c680a02 Use Python-ish, not C++, parameter types in Python documentation.
Using C++ types in documentation for Python users is more harmful than
useless, so use Python types whenever possible and allow defining "doctype"
typemap to customize this for the user-defined types.
2014-08-22 17:45:22 +02:00
Vadim Zeitlin
5c0ed6c635 No changes, just spelling fixes in Doxygen branch changes.
Most are just typos, but also s/JavaDoc/Javadoc/ and s/PythonDoc/Pydoc/ as
this is how they are officially called.
2014-05-07 19:12:10 +02:00
Marko Klopcic
9cd379b800 fixed bug with autodoc, manual updated with table description and tests description 2013-02-21 22:50:15 +01:00
Marko Klopcic
43eeb4528c warnings eliminated, examples fixed, only doxygen_misc_constructs is not working now 2013-01-22 23:21:02 +01:00
Marko Klopcic
20cc685e8a tests with escapes added, tests refactored - broken to smaller chunks 2013-01-10 22:26:50 +01:00
Marko Klopcic
e62580acb8 fixed doxy documentation (also shortened lines), added test for discovered bug reltaed to nested enums
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13728 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-08-28 20:59:32 +00:00
Dmitry Kabak
1eb664cad2 Updated docs
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13636 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-08-16 15:13:35 +00:00
Dmitry Kabak
423915eef6 Added some docs, updated project-plan
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13577 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-08-09 19:06:58 +00:00
Dmitry Kabak
51e184f134 Added special doxygen features description to docs
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13523 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-08-05 16:22:48 +00:00
Dmitry Kabak
64b5efc5d7 Updated documentation, added description of PyDoc tags
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13429 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-07-30 08:07:15 +00:00
Dmitry Kabak
8260f4219f Expanded the Doxygen docs
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13428 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-07-29 22:26:31 +00:00
Dmitry Kabak
4141c9fd87 Added doxygen switches doc
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13185 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-06-18 19:31:35 +00:00
Dmitry Kabak
744d59c9d0 Small documentation fix in Doxygen.html
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13141 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-06-03 16:40:31 +00:00
William S Fulton
2cd2dac7e6 type fix
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2008-cherylfoil@10895 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2008-11-01 21:48:20 +00:00
William S Fulton
721327573b fix typo and main ref
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2008-cherylfoil@10823 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2008-09-08 20:04:34 +00:00
William S Fulton
8486cc9f43 rename DoxygenTranslation.html to Doxygen.html
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2008-cherylfoil@10818 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2008-09-08 19:40:04 +00:00
Renamed from Doc/Manual/DoxygenTranslation.html (Browse further)