Commit graph

80 commits

Author SHA1 Message Date
William S Fulton
33921666a1 Merge branch 'vadz-doxygen'
This is the Doxygen work begun in Google Summer of Code projects 2008
and 2012 and subsequently improved by numerous contributors.

* vadz-doxygen: (314 commits)
  Add changes entry for Doxygen support
  Add some missing doctype tyemaps
  Doxygen warnings cleanup
  Move doxygen warning numbers
  Add Python doxygen example
  Doxygen example
  Add Doxygen to include paths
  Doxygen source rename
  More merge fixes from doxygen branches
  Correct python example headers
  Correct source code headers
  Another merge fix from doxygen branches
  Java enums output format fixes
  Add omitted doxygen_parsing_enums testcase
  PEP8 conformance for comment verifier module
  Clean up merge problem
  Doxygen html tweaks
  Update html chapter numbering for added Doxygen chapter
  Fixes to makechap.py to detect ill-formed headers
  html fixes for Doxygen
  Add missing CPlusPlus17.html file
  Format files to unix format
  Doxygen testcase tweak to match that in the html docs
  Doxygen html documentation updates and corrections
  Remove doxygen Examples subdirectory
  Beautify doxygen source code
  Code formatting fixes in doxygen code
  Remove unused doxygen code
  new_node refactor
  Various merge fixes in doxygen branches
  Unused variable warning fix
  Fix wrongly resetting indent after formulae in Doxygen comments
  Add support for doxygen:alias feature
  Get rid of meaningless return type of DoxygenParser methods
  Return enum, not untyped int, when classifying Doxygen commands
  Get rid of unnecessary "typedef enum" in C++ code
  Use slash, not backslash, in "C/C++" in the documentation
  Replace literal "<" with "&lt;" in HTML documentation
  Fix broken link to java.sun.com in Doxygen documentation
  Fix using com.sun.tools.javadoc package under macOS
  Fix error reporting for special characters in Doxygen parsing code
  Switch Python Doxygen unit tests to use inspect.getdoc()
  Use correct separator in Java class path under Windows.
  Remove executable permission from appveyor.yml.
  Use JAVA_HOME value in configure to detect Java.
  Display JAVA_HOME value in "make java_version".
  Fix harmless MSVC warning in DoxygenTranslator code.
  Reset "_last" for all but first enum elements.
  Don't duplicate Javadoc from global enum Doxygen comments twice.
  Move Doxygen comments concatenation from the parser to the lexer.
  Fix shift/reduce conflicts in Doxygen pre/post comment parsing.
  Rewrote part of the grammar dealing with Doxygen comments for enums.
  No changes, just remove spurious white space only differences.
  Move Doxygen comment mangling from the parser to the lexer.
  Merge "-builtin" autodoc bugs workarounds from master into test.
  Quote JAVA_HOME variable value in Java test suite makefile.
  Remove unused C_COMMENT_STRING terminal from the grammar.
  Fix missing returns in the Doxygen test suite code.
  Fix trimming whitespace from Doxygen comments.
  Remove code not doing anything from PyDocConverter.
  Remove unused <sstream> header.
  Remove unreferenced struct declaration.
  Remove unused Swig_warn() function.
  Remove any whitespace before ignored Doxygen commands.
  Remove trailing space from one of Doxygen tests.
  Fix autodoc strings generated in Python builtin case and the test.
  Fix Doxygen unit test in Python "-builtin" case.
  Use class docstrings in "-builtin" Python case.
  Don't indent Doxygen doc strings in generated Python code.
  Add a possibility to flexibly ignore custom Doxygen tags.
  Stop completely ignoring many Doxygen comments.
  Fix structural Doxygen comment recognition in the parser.
  No changes, just make checking for Doxygen structural tags more sane.
  Use "//", not "#", for comments in SWIG input.
  Allow upper case letters and digits in Doxygen words.
  Pass the node the Doxygen comment is attached to to DoxygenParser.
  Get rid of findCommand() which duplicaed commandBelongs().
  Recognize unknown Doxygen tags correctly.
  No real changes, just pass original command to commandBelongs().
  Describe Doxygen-specific %features in a single place.
  Give warnings for unknown Doxygen commands in Doxygen parser.
  Document the return type when translating Doxygen @return to Python.
  Fix translated Doxygen comments for overloaded functions in Python.
  Also merge Doxygen comments for overloaded constructors in Python.
  Allow using enum elements as default values for Python functions.
  Don't always use "*args" for all Python wrapper functions.
  No real changes, just make PYTHON::check_kwargs() const.
  Refactor: move makeParameterName() to common Language base class.
  Remove long line wrapping from Python parameter list generation code.
  Simplify and make more efficient building Python docstrings.
  Translate Doxygen code blocks to Sphinx code blocks.
  Add a simple test of multiple parameters to Doxygen test suite.
  Make Python parameters types hyperlinks in the doc strings.
  Make Language::classLookup() and enumLookup() static.
  Fix arguments of @param, @return etc translations to Python.
  Remove unused method from PyDocConverter.
  No real changes, just remove an unnecessary variable.
  Preserve relative indentation when parsing Doxygen comments.
  Use Sphinx-friendly formatting for overloaded functions documentation.
  Add poor man trailing white space detection to Doxygen Python tests.
  ...
2018-06-07 08:13:10 +01:00
Olly Betts
d6d5db122b Remove support for PHP5
PHP5 is no longer actively supported by the PHP developers and security
support for it ends completely at the end of 2018, so it doesn't make
sense to include support for it in the upcoming SWIG 4.0.0 release.

See #701.
2018-06-07 18:09:03 +12:00
William S Fulton
4cdca98709 Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
William S Fulton
066c396ad6 Add C++17 documentation chapter 2018-05-14 21:29:46 +01:00
William S Fulton
d5d97a4069 Overloaded methods section renamed slightly in docs 2017-09-14 18:51:36 +01:00
William S Fulton
32a454cfef Merge branch 'templates-scope-enforcement'
* templates-scope-enforcement:
  Test a few %template errors
  Add using declarations to templates into typedef table.
  Fix type lookup in the presence of using directives and using declarations
  More docs on %template
  Testcase fix for nameclash in php
  %template scope enforcement and class definition fixes
  Template documentation tweaks
  More consistent formatting of examples in documentation
  More consistent formatting of examples in documentation
  Documentation corrections to use targetlang formatting
  More consistent formatting of examples in documentation
  More consistent formatting of examples in documentation
  More consistent formatting of examples in documentation
  Namespace documentation minor corrections
  Improve description of template_parameters_resolve
  Minor code optimisation in template_parameters_resolve
  Fix scope lookup for template parameters containing unary scope operators
  Typemap change for templates
2017-08-16 21:44:51 +01:00
William S Fulton
04131a988f More consistent formatting of examples in documentation 2017-08-16 00:24:25 +01:00
William S Fulton
7ee76f93f9 More consistent formatting of examples in documentation 2017-08-16 00:24:25 +01:00
Olly Betts
90f9117e10 Fix various comment and documentation typos 2017-08-13 18:04:33 +12:00
Nihal
21108781a7 Add documentation and examples for php version pragma.
Pragma version to specify versions for PHP5 and PHP7 extensions.
See issue #360.
2017-05-08 12:02:53 +05:30
sunoru
8985c34809 Fix some typos in docs and examples and make the code look nicer. 2016-12-31 23:06:56 +08:00
Olly Betts
07b7edcd87 [php] Improve %feature("director:except") docs
See https://github.com/swig/swig/pull/628
2016-12-15 17:16:20 +13:00
Olly Betts
75a00cd15e [PHP7] Make default C++ extension .cxx
This is SWIG's default for every language except PHP, and now is a
good time to make this change so that once we drop PHP5 support, we'll
have the same default everywhere.  It's easy to override the default
with -cppext cxx to get the PHP5 behaviour.
2016-11-30 13:27:13 +13:00
Olly Betts
f4d8a7f78b PHP now generates E_NOTICE for misspelled constant 2016-11-30 13:07:17 +13:00
Olly Betts
1169874f59 [PHP] Add support for PHP7.
PHP5's C extension API has changed substantially so you need to use
-php7 to specify you want PHP7 compatible wrappers.
Fixes https://github.com/swig/swig/issues/571
2016-11-30 13:05:59 +13:00
William S Fulton
268b942865 Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
William S Fulton
3763beb489 Replace tabs with spaces in html docs
wkhtmltopdf is not expanding tabs within <pre> elements to 8 spaces as it
should. Workaround the problem by converting all tabs to an appropriate
number of spaces.
2015-12-30 22:22:33 +00:00
William S Fulton
925b2a336f HTML fixes for documentation - add meta tag and loose.dtd 2015-12-30 22:22:32 +00:00
William S Fulton
cacb36bedb Docs - remove html tags from headings 2015-12-30 22:22:32 +00:00
William S Fulton
8288ac15a0 Correct links in html documentation using new version of makechap.py
Corrects position of heading text within A and H1, H2, ... elements.
2015-12-30 22:22:32 +00:00
William S Fulton
30537089ca HTML tweaks 2014-12-29 21:54:58 +00:00
Olly Betts
01faf1baf9 using an unknown constant emits a notice, not a warning 2014-11-18 12:51:30 +13:00
Olly Betts
1cfc099d91 Fix typo 2014-11-18 12:51:08 +13:00
Natanael Arndt
396f286a02 Fix #224
Fix the PHP section of the documentation to include both source files resp. object files in the example command lines
2014-11-09 23:16:38 +01:00
Olly Betts
1a99212c2c [PHP] Add support for specifying any PHP interfaces a wrapped class
implements, e.g.: %typemap("phpinterfaces") MyIterator "Iterator";
2014-09-12 12:48:37 -03:00
Olly Betts
c43f84af02 Improve PHP docs about extension= and dl() 2014-08-12 14:45:54 +12:00
Ian Bell
b8d3ff060a Update Php.html
Short summary of the fact that dl() function can no longer be used.
2014-08-11 20:46:49 +02:00
William S Fulton
4a680e5545 html doc chapter numbering update since adding Javascript 2014-05-09 23:39:03 +01:00
William S Fulton
785d93d9fb html fixes and section updates 2014-03-15 22:45:43 +00:00
Miklos Vajna
324818030b PHP: document byref typemap attribute 2014-01-06 14:26:54 +13:00
Olly Betts
bef3cfe594 Add CHANGES.current entry and minimal doc update for previous change 2013-12-12 16:06:00 +13:00
William S Fulton
c47fd5fdd5 Director documentation corrections to match reality.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@13136 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-05-30 05:59:46 +00:00
Olly Betts
95821b7a04 Note that technique relying on call-time pass by reference won't work with
PHP 5.4.


git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@13094 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-05-18 02:19:46 +00:00
Olly Betts
dba3dc5148 Minor improvements to the text.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@13059 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2012-05-10 06:09:15 +00:00
William S Fulton
d005a2cc3f New section numbering adding in Android chapter
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12869 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-12-10 16:53:04 +00:00
Olly Betts
5cf5f252d3 Improvements to PHP documentation
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12863 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-12-06 00:39:19 +00:00
William S Fulton
ff2d735866 Section numbering update
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12770 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-08-04 06:23:24 +00:00
Olly Betts
7d584f5204 Clarify the text about remaining PHP constant oddity.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12752 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-06-25 12:48:08 +00:00
Olly Betts
e3b5627ab5 Remove example of odd behaviour of PHP constants which I can't reproduce. It
seems highly likely it's been fixed in PHP now, as the example dates from PHP4
days.


git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12750 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-06-24 17:18:43 +00:00
William S Fulton
005b70be3a Chapter renumbering after adding D chapter
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12376 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2011-01-07 20:05:44 +00:00
William S Fulton
863aab5b4c Chapter renumbering after Go added
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12112 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2010-06-10 06:10:55 +00:00
William S Fulton
9f99c73221 minor clarification in Php docs
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12104 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2010-06-08 05:37:49 +00:00
Olly Betts
9622d908ae Fix typo reported in SF#3011286 by Ben Ceschi.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12100 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2010-06-04 05:14:14 +00:00
William S Fulton
673ce4551e Fix numerous broken links reported by linkchecker
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11924 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2010-03-06 23:23:43 +00:00
William S Fulton
3932d02a2a fix SWIG naming convention
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11663 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2009-08-21 00:25:11 +00:00
William S Fulton
f0fb2f3851 Remove 'under construction' notes
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11636 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2009-08-18 14:08:50 +00:00
Miklos Vajna
0249eea389 Merge https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2009-vmiklos/
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11434 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2009-07-22 11:08:29 +00:00
William S Fulton
23a5f4f955 quote %include statements
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11283 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2009-06-17 06:56:55 +00:00
Olly Betts
6ae7ce1cf1 Remove note which is no longer relevant.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@11216 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2009-05-19 12:00:48 +00:00
William S Fulton
9ed9e006bc new section numbering since adding in ccache chapter
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@10991 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2008-12-20 01:49:58 +00:00