Commit graph

89 commits

Author SHA1 Message Date
William S Fulton
6c0045b3fc HTML chapter numbering updates 2018-06-07 08:16:36 +01:00
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
William S Fulton
4cdca98709 Update html chapter numbering for added Doxygen chapter 2018-05-25 07:56:44 +01:00
luz.paz
4434809e13 Changed scilab.html link anchor name per request 2018-05-17 10:06:23 -04:00
luz.paz
706c91554c fixed typo again after merge conflict 2018-05-17 10:04:23 -04:00
luz.paz
60dfa31a67 Misc. typos
found via `codespell` and `grep`
2018-05-17 10:04:23 -04: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
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
Simon Marchetto
c06c9b3853 [Scilab] New parameter targetversion to specify the Scilab target version (5, 6, ..) for code generation
With Scilab 6 target specified, identifier names truncation is disabled (no longer necessary)

Signed-off-by: Simon Marchetto <simon.marchetto@scilab-enterprises.com>
2017-04-12 13:54:42 +02:00
sunoru
8985c34809 Fix some typos in docs and examples and make the code look nicer. 2016-12-31 23:06:56 +08:00
William S Fulton
268b942865 Consistent formatting of example code in the docs 2016-10-23 20:16:35 +01:00
Olly Betts
5839d9cce0 Use relative link to another manual chapter
Explicitly linking to the copy on the website breaks the link for
those browsing installed documentation offline.
2016-08-27 11:12:16 +12:00
William S Fulton
b0ba1cae76 html doc fixes
[skip ci]
2016-05-06 07:36:58 +01:00
Simon Marchetto
6c254d1ebb scilab: fix doc (pointer type tracking) 2016-04-06 13:22:59 +02: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
019bdf9067 More link fixes in the docs 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
862b4c6138 Add a linkchecker target for checking broken links in SWIGDocumentation.html 2015-12-18 21:14:39 +00:00
Simon Marchetto
ec6d46f387 scilab: fix doc typos 2015-03-24 16:52:18 +01:00
William S Fulton
72c78591df html fixes 2015-01-31 17:39:37 +00:00
William S Fulton
5dba60943c Scilab html fixes 2015-01-27 19:30:24 +00:00
Simon Marchetto
33fba2020b scilab: other doc minor fixes 2015-01-26 16:05:03 +01:00
Simon Marchetto
7c9a9aee70 cosmetic changes in doc 2015-01-26 14:54:05 +01:00
Simon Marchetto
0544765abd remove -nobuilder option 2015-01-26 12:29:40 +01:00
William S Fulton
6f48e57090 Scilab command line options put in alphabetical order and some html tweaks 2015-01-22 20:03:16 +00:00
Simon Marchetto
388d8fd007 change 'Module' section to 'Builder modes' and other fixes 2015-01-14 15:44:28 +01:00
Simon Marchetto
c064e076bd update doc 2015-01-12 17:47:56 +01:00
Simon Marchetto
fd1e387a0e scilab: rename build command line options 2014-10-21 17:00:51 +02:00
Simon Marchetto
30faff1fce scilab: remove outputlibrary option + renaming module to gateway 2014-10-21 14:39:18 +02:00
Simon Marchetto
32c76be163 scilab: change swig options, new option -gatewayxml, remove -internalmodule 2014-10-17 17:33:27 +02:00
Simon Marchetto
c821ba603d scilab: fix doc 2014-08-19 17:34:49 +02:00
Simon Marchetto
821118de9b scilab: rename swig_this(), swig_ptr() to SWIG_this(), SWIG_ptr() 2014-06-26 09:44:49 +02:00
Simon Marchetto
17af863d58 scilab: add link in 'Other resources' section 2014-06-16 17:29:36 +02:00
Simon Marchetto
c1c706fbd8 scilab: update doc (unsigned ints typemaps changes) 2014-06-16 17:08:25 +02:00
Simon Marchetto
3ac0dc2be5 scilab: rename matrix typemaps named parameters 2014-06-13 16:21:21 +02:00
Simon Marchetto
a531ea2f27 scilab: fix command line option names 2014-06-12 18:09:19 +02:00
Simon Marchetto
5f8552d9d9 scilab: small fixes in doc 2014-06-12 18:09:19 +02:00
William S Fulton
f8674b1ad9 Documentation proof reading edits 2014-06-12 07:29:39 +01:00
Simon Marchetto
ab7a095758 scilab: swig supports scilab 6 2014-06-11 16:50:55 +02:00
Simon Marchetto
4477699ae8 scilab: fix doc after rereading 2014-04-23 17:57:40 +02:00
Simon Marchetto
eb62899fac scilab: document STL exceptions 2014-04-09 10:30:36 +02:00
Simon Marchetto
542abaf846 scilab: document namespaces 2014-04-07 12:44:52 +02:00
Simon Marchetto
1c207f76d0 scilab: document C++ exceptions 2014-04-07 11:33:39 +02:00
Simon Marchetto
a87c6f9bf2 scilab: in doc add chapter "pointers, references, values, arrays" 2014-04-04 09:34:29 +02:00
Simon Marchetto
cbf4a9e583 scilab: document C++ operators 2014-04-03 17:24:08 +02:00
Simon Marchetto
9fbcc0cee4 scilab: some fixes in doc 2014-04-03 09:59:02 +02:00
Simon Marchetto
a9397c3b49 scilab: rewrite doc on templates 2014-04-02 18:05:26 +02:00