jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
17,385 commits 2 branches 0 tags 67 MiB
Commit graph

127 commits

Author SHA1 Message Date
Vadim Zeitlin
8b83976f4c Fix arguments of @param, @return etc translations to Python. 
For the parameter documentation to be really taken as such, in its entirety,
by Sphinx, it must be indented relative to the :param: tag. Do this by
appending an extra indent after every line of the output and work around the
unnecessary indent of the last line by removing the trailing whitespace.

This required updating the existing tests and removing the expected but not
present any more whitespace from them, but as trailing whitespace in the
documentation is at best insignificant (and at worst harmful) anyhow, this is
not a big price to pay for simpler translator code.
 2014-08-22 17:45:22 +02:00
Vadim Zeitlin
70d3533e12 Remove unused method from PyDocConverter. 
justifyString() was unused and doesn't seem to be useful as there are no
particular constraints on the line length in Python documentation, so just
preserve whatever is used in the original C++ code.
 2014-08-22 17:45:22 +02:00
Vadim Zeitlin
b833dbe302 No real changes, just remove an unnecessary variable. 
Avoid copying "pyDocString" to "result" completely unnecessary, just use
"pyDocString" itself directly.
 2014-08-22 17:45:22 +02:00
Vadim Zeitlin
14ba3b8dd4 Preserve relative indentation when parsing Doxygen comments. 
This is important to preserve the structure of the lists which appear
correctly in Python output without any additional effort if the indentation is
lost.

It is also makes the behaviour consistent for

	/**
	 *
	 *
	 */

comments and those without the asterisks in the middle lines, as now the
indentation is preserved in both cases while it was only preserved when the
asterisks were present previously.
 2014-08-22 17:45:22 +02:00
Vadim Zeitlin
ea1d56da67 Use Sphinx-friendly formatting for overloaded functions documentation. 
Sphinx doesn't allow sections inside the function documentation and gives tons
of SEVERE warnings for them, so while just emphasizing the "Overload" header
is not ideal, it is better than before because at least the string "Overload"
itself appears in the Sphinx-generated output.
 2014-08-22 17:45:22 +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
d677321323 No real changes, just rewrite the parameter iteration loop to be more clear. 
Also remove unused commented out code.
 2014-08-22 17:45:21 +02:00
Vadim Zeitlin
3db8c1fca2 Fix memory leaks in Doxygen to PyDoc parameter types conversion code. 
Don't forget to delete the local copy of parameter list and the temporary
string.
 2014-08-22 17:45:21 +02:00
Vadim Zeitlin
b96dd8bb97 Implement translation of Doxygen formulae to Sphinx notation. 
This allows to automatically have nicely looking formulae in HTML output when
using Sphinx with e.g. sphinx.ext.mathjax extension.
 2014-08-22 17:45:21 +02:00
Vadim Zeitlin
7d2743a0bb Use reST inline markup in PyDocConverter instead of Markdown. 
reST is standard Python markup, so use *...*, ``...`` and so on instead of
_..._, '...' etc.

No other changes even though the mapping of some Doxygen tags to markup used
for them seems suspicions (e.g. \var almost certainly should be the same as
\em).
 2014-08-13 16:11:30 +02:00
Vadim Zeitlin
b374aad0da Use Sphinx-compatible docstring format in PyDocConverter. 
Use the more or less standard :param:, :type:, :return: and :raises: in the
function/methods descriptions.

Update the output expected from the Python tests accordingly.
 2014-08-13 16:11:30 +02:00
Vadim Zeitlin
a76c1343b7 Simplify management of tag handlers in PyDocConverter. 
Avoid having to pass dummy empty string arguments, just use default value for
the unused last parameter of handleParagraph().

Also get rid of dozens of "" occurrences in the tag map initialization code,
use a helper function instead.

No real changes.
 2014-08-13 16:11:30 +02:00
Vadim Zeitlin
f684242467 Replace DoxygenTranslator debug parameters with a single flags one. 
This makes the code more readable and more extensible as more flags are easier
to add in the future than more boolean parameters.

No user-visible changes.
 2014-08-13 16:11:30 +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
Vadim Zeitlin
ed40190fe1 Remove unused and apparently unnecessary file. 
This is probably another Eclipse (?) leftover.
 2014-05-07 18:43:50 +02:00
Yann Diorcet
b2c5c70f1b Fix link additional text in doxygen 2013-04-22 14:28:24 +02:00
Marko Klopcic
4663fce63c fixed bug in handling of ref tag in Java, added handling in Python 2013-03-17 20:09:34 +01:00
Marko Klopcic
4e2c1e3ac3 added handling for tag ref in Java 2013-03-16 10:53:48 +01:00
Marko Klopcic
00ff8886c6 formatting updated 2013-02-23 16:46:14 +01:00
Marko Klopcic
530d65a98c added fix for word commands aqnd ellipsis 2013-02-23 16:44:09 +01:00
Marko Klopcic
3b7908fa6e fixed leading spaces for the second row of table in pydoc, sources formatted 2013-02-23 15:20:27 +01:00
Marko Klopcic
b5dea7456b improved handling of word commands if puntuation is following the word, preserved spaces at start of comment line 2013-02-21 09:05:11 +01:00
Marko Klopcic
2a8b20785e fixed bug in handling of HTML tags, test added 2013-02-19 07:25:13 +01:00
Marko Klopcic
0b6bc80038 Translation of HTML tags to Python almost finished 2013-02-13 23:06:20 +01:00
Marko Klopcic
560dedb6c0 added handling of HTML tags and HTML entities to PyDocConverter, updated tests 2013-02-12 22:58:50 +01:00
Marko Klopcic
29d1bba70a improved comment formatting for Python 2013-02-02 23:01:09 +01:00
Marko Klopcic
1883797742 refactored comment tokenizer 2013-01-29 22:58:10 +01:00
Marko Klopcic
2896938879 only whitespace cnhanges and code comment update 2013-01-29 08:13:03 +01:00
Marko Klopcic
a2a345be39 improved handling of @see tags - SWIG no longer crashes if right brace is missing 2013-01-28 22:25:40 +01:00
Marko Klopcic
2df4449e3b commands \f? (LateX formulas) are no longer ignored - formulas are copied literally to Java comments 2013-01-28 20:07:36 +01:00
Marko Klopcic
9a1bb671c1 fixed bug with caption in command 'image' 2013-01-27 22:18:06 +01:00
Marko Klopcic
8de06366cf fixed handling of quoted text adn standalone backslash and @ 2013-01-23 23:15:36 +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
f6fc808534 fixed handling of < and > when they are not used for html tag 2013-01-21 22:22:02 +01:00
Marko Klopcic
a2b0d42c32 fixed tests for HTML entities and handling of HTML entities 2013-01-18 22:30:23 +01:00
Marko Klopcic
4955cdaac6 added handling of HTML entities 2013-01-18 22:22:22 +01:00
Marko Klopcic
13d2dad679 added tests for HTML tags, bugs in HTML tags fixed 2013-01-18 21:21:12 +01:00
Marko Klopcic
f25d03612b added the missing doxy command 'example' 2013-01-17 23:17:06 +01:00
Marko Klopcic
7984516b31 implemented translation of HTML tags - they are handled as a special class of commands 2013-01-16 23:15:14 +01:00
Marko Klopcic
32f34e16be improved commands for escaped characters 2013-01-13 20:02:39 +01:00
Marko Klopcic
a9ef35bc66 Parsing of comments to tokens rewritten so that html entities and html tags are now treated as commands. Whitespaces are also preserved more acurately, so some doxygen tests fail at the moment 2013-01-10 08:51:56 +01:00
Marko Klopcic
8d61aae0fb fixed handling of /******/ comments, added tests for backslash handling, which fail 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13733 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-09-06 20:56:19 +00:00
Marko Klopcic
2f77dbc7f4 fixed prepending '*' to nontranslated comments by taking also tabs into account 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13731 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-30 20:35:23 +00:00
Marko Klopcic
e50d37664f if feature doxygen:notranslate is used, comments are now properly decorated with '*'s. 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13730 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-29 21:26:11 +00:00
Marko Klopcic
af74b4f96a renamed test case 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13726 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-27 20:25:00 +00:00
Marko Klopcic
46f2a16608 more refactoring, typedefs were introduced, DoxyCommandEnum moved to DoxygenParser 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13725 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-26 20:07:57 +00:00
Marko Klopcic
c9eda79264 refactored DoxygenEntity class 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13724 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-26 15:34:46 +00:00
Marko Klopcic
a753f3e799 removed files with classes wich were made obsolete by previous commit 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13723 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-26 13:07:09 +00:00
Marko Klopcic
ed6df45c0a refactored DoxygenParser: class Token is now nested in Doxygen parser because it is only used there, class TokenList has been removed - it more or less duplicated std::list, other code moved to DoxygenParser 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13722 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-26 13:00:52 +00:00
Dmitry Kabak
549b2046b1 Fixed comments in the source code 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/branches/gsoc2012-doxygen@13668 626c5289-ae23-0410-ae9c-e8d60b6d4f22
 2012-08-19 14:42:26 +00:00