Commit graph

1,304 commits

Author SHA1 Message Date
William S Fulton
2ad0e784ab Minor documentation tweak 2016-01-26 19:55:10 +00:00
Olly Betts
f910607e26 Fix typo: "neccessary" -> "necessary" 2016-01-12 13:37:39 +13:00
Olly Betts
b3bedc210c [Javascript] For v8 >= 4.3.0, use V8_MAJOR_VERSION.
Fixes https://github.com/swig/swig/issues/561.
2016-01-12 09:33:13 +13:00
William S Fulton
a8cf1eddf8 Bump version to 3.0.9 2015-12-31 18:04:16 +00:00
William S Fulton
719c7d532c htmldoc patch no longer needed since pdf docs are now generated by wkhtmltopdf 2015-12-31 18:00:39 +00:00
William S Fulton
ec91de75b7 swig-3.0.8 release update 2015-12-30 22:23:47 +00:00
William S Fulton
28e1a64dcb html docs update 2015-12-30 22:22:33 +00:00
William S Fulton
58279a4627 HTML pdf doc generation fixes
wkhtmltopdf isn't using a fixed-width font for CSS font-family:monospace.
Nor is it using one for <PRE> <CODE> or <TT> elements.
Add in some Courier fonts for it to use - note that Courier 10 Pitch is
installed on Ubuntu by default. Note these fonts need to be installed on
the system that generates the pdf documentation.

Previously the htmldoc stylesheet was kept in place and the SWIG
stylesheet was prepended to it inline in SWIGDocumentation.html.
Now the SWIG stylesheet has been amended with most of the htmldoc
stylesheet changes and completely replaced after htmldoc is run.
2015-12-30 22:22:33 +00:00
William S Fulton
f278fdac59 Replace pdf documentation generation tool with wkhtmltopdf from htmldoc
htmldoc does not seem to be generating pdfs properly any more (on Ubuntu
14.04). It has been replaced with wkhtmltopdf which is better as it
supports css and so the patched version of htmldoc with the simple css
support is no longer required. wkhtmldoc does have have a few problems
though which have been addressed in prior commits:

- <H1><a name="X"></a>Text</H1> style links need changing to:
  <H1><a name="X">Text</a></H1>
- tabs in <pre> elements should be expanded to 8 spaces by default, but
  are expanded to just one space and css expand-tab is not recognised.

The <pre> <tt> <code> elements do not always select a fixed-width font -
try installing a Courier font.
2015-12-30 22:22:33 +00: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
4e67d5c7a8 Minor html fixes 2015-12-30 22:22:33 +00:00
William S Fulton
870b0f1505 html fixes 2015-12-30 22:22:32 +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
fc68136880 link fixes 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
41a02723e6 Remove broken link in docs 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
abe42bbb16 Correct html documentation linking generated by makechap.py script
Corrects position of heading text to be as mentioned in the 4.01
transitional standard, see http://www.w3.org/TR/html4/struct/links.html#h-12.1.1.
For example, changes

<H1><a name="Introduction"></a>2 Introduction</H1>
to
<H1><a name="Introduction">2 Introduction</a></H1>

The changes will convert the old incorrect usage should an html file
using the old approach be added in the future.
2015-12-30 22:22:31 +00:00
William S Fulton
01611702ec Python 2 Unicode strings can be used as inputs to char * or std::string types
Requires SWIG_PYTHON_2_UNICODE to be defined when compiling generated code.
2015-12-19 03:55:26 +00:00
William S Fulton
0ae5bfa6e2 html links updates 2015-12-18 21:14:44 +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
William S Fulton
e069365775 html fixes 2015-12-17 13:57:17 +00:00
William S Fulton
64dcd50b99 Remove dependency on yodl tools and remove ccache-swig man page
Use the CCache.html docs instead of the ccache-swig man page.
The yodl2man and yodl2html tools are no longer used and so SWIG no
longer has a dependency on these packages which were required when
building from git.

Closes #286
Closes #128
2015-12-17 02:36:48 +00:00
William S Fulton
51ee23b580 Link to distutils fix 2015-12-05 19:25:18 +00:00
William S Fulton
b69719eb5b changes file note and docs for std::array 2015-11-25 19:20:36 +00:00
William S Fulton
803ba97a83 Update docs for shared_ptr 2015-10-01 22:36:01 +01:00
William S Fulton
37e60f450f Ruby tracking doc fixes 2015-09-13 14:53:25 +01:00
William S Fulton
0ee304188c Merge branch 'lyze-cffi-export-package'
* lyze-cffi-export-package:
  Add user documentation to the export package extension.
  Extend the export feature in the CFFI module to support exporting to a particular package.
2015-09-09 22:32:43 +01:00
William S Fulton
b5873218b6 Ruby mark_function example and docs fixes
Relates to Ruby trackings hash bug #225
2015-09-05 15:30:50 +01:00
Michael Schaller
d5cf0ab111 First batch of changes after code review by @ianlancetaylor for pull request #502. 2015-08-27 10:09:50 +02:00
Michael Schaller
8d2f3403d2 [Go] Reworked beginning of the documentation.
* Removed link to examples in the Go source tree as discussed in issue #418.
* Reworded occurences of the 'gc tool' as it has been removed with Go 1.5.
* Reworked chapter 23.3.  This should make it easier for users to get started
  with SWIG as the chapter starts with how to use SWIG with the go tool.
* Added helpful links.
2015-08-27 08:27:43 +02:00
David Xu
c8b15f64a0 Add user documentation to the export package extension. 2015-08-09 13:58:04 -04:00
Michael Schaller
608ef60ecf [Go] Renamed 'FooBarAbs' to 'FooBarAbstract' in the documentation and examples. 2015-08-09 14:37:16 +02:00
xantares
92328a2016 pep257 & numpydoc conforming docstrings 2015-08-07 22:15:13 +01:00
Michael Schaller
d9d26149e7 Some minor changes after first code review by ianlancetaylor.
Renamed overwritenMethodsOnFooBarAbs to overwrittenMethodsOnFooBarAbs.
Changed some line breaks.
2015-08-04 09:50:56 +02:00
Michael Schaller
94994a749e Removed empty line in table of contents of the Go documentation. 2015-08-04 09:34:26 +02:00
Michael Schaller
a17c9727bd Fleshed out Go's documentation about the director feature and added a director example.
Fixes issues #418.
2015-08-04 09:34:26 +02:00
William S Fulton
5d363276f5 Bump version to 3.0.8 2015-08-03 22:33:52 +01:00
William S Fulton
9d509ba92b Add 3.0.7 release summary and release date 2015-08-02 22:51:59 +01:00
William S Fulton
c6f8aadc64 Cosmetic corrections - Mac OS X 2015-08-02 20:14:20 +01:00
William S Fulton
9c23981992 HTML fix in docs 2015-08-02 19:47:02 +01:00
William S Fulton
a1771cb8a0 Fix potential security exploit in generated Java classes 2015-08-02 11:22:46 +01:00
William S Fulton
f482adc6d1 Add documentation and CHANGES for special variables and typemap attributes.
Also add info about special variable expansions in special variable
macros.
2015-07-22 23:28:26 +01:00
Karl Wette
8261fc7fc4 Update CHANGES.current and Octave.html to indicate Octave 4.0.0 support 2015-07-17 09:49:44 +02:00
William S Fulton
55686fbe56 Bump version to 3.0.7 2015-07-06 06:55:43 +01:00
William S Fulton
d9bfccfc4e Add 3.0.6 release notes and release date 2015-07-05 17:16:38 +01:00
William S Fulton
3b859ab539 Html doc fixes 2015-07-05 17:16:37 +01:00
Olly Betts
8208d12aa5 Document use of %pythoncode "file.py"
As discussed in github issue #379.
2015-06-29 22:24:59 +12:00
William S Fulton
e180430f1e -external-runtime doc improvement
Closes #441
[skip ci]
2015-06-16 19:53:09 +01:00