15 Commits

Author SHA1 Message Date
Colomban Wendling
44694f638b Remove unused classes from the GtkDoc header generation script 2016-03-01 16:37:08 +01:00
Colomban Wendling
9ce7c22ad7 Fix Doxygen generation instead of working around incorrect output
Make Doxygen ignore `G_{BEGIN,END}_DECLS` and `GEANY_API_SYMBOL` itself
instead of stripping those manually when parsing the XML output.

This makes Doxygen parsing more robust by ignoring some odd C syntax,
and also improves the HTML version removing some incorrect C code
references.
2016-03-01 16:34:05 +01:00
Colomban Wendling
6f79a94cec Add GPL header to GtkDoc header generation script 2016-02-29 00:34:27 +01:00
Colomban Wendling
00f0ce5991 PEP8 the GtkDoc header generator script a little
But use 110 as line length and leave visual operators alignment alone.
2016-02-28 04:49:51 +01:00
Colomban Wendling
e4bdf45cc6 Add support for out and optional GI annotations 2016-02-28 01:58:48 +01:00
Colomban Wendling
2b8cfb3f84 Use %NULL, %FALSE and %TRUE in the GtkDoc output 2016-02-28 01:02:52 +01:00
Colomban Wendling
7f9129c938 Mark private fields as private in the GtkDoc header 2016-02-20 22:45:53 +01:00
Colomban Wendling
91daa9f9db Fix handling of some GtkDoc annotations 2016-02-19 00:03:30 +01:00
Thomas Martitz
c35f29ae36 scripts: gen-api-gtkdoc.py cleanup
- do not write out scintilla_object_* functions
- remove scioutput file parameter
- do not open output file until after xml parsing to avoid stale files
- fixed simplesect handling
- handle output being a pipe to head or tail
2016-02-16 07:14:11 +01:00
Matthew Brush
8033e26180 Remove commented-out code 2016-02-16 06:52:09 +01:00
Matthew Brush
5a391c79c3 Replace comments and asserts with doc-comments and doc-tests 2016-02-16 06:52:09 +01:00
Matthew Brush
4f3e32e95f Rename global "constant" to follow PEP-8 naming 2016-02-16 06:52:08 +01:00
Matthew Brush
402e771c9b Use 4-space indentation to follow PEP-8
The other Python scripts already follow this convention.
2016-02-16 06:52:08 +01:00
Matthew Brush
5534e5cca0 Move globals into main() function
This prevents running a bunch of top-level code if the module is
ever imported and cleans-up the global namespace.
2016-02-16 06:52:08 +01:00
Thomas Martitz
658821d2dd api: add script to generate {geany,geany-scintilla}-gtkdoc.h
The script reads the doxygen xml output and generates two headers (optionally
a single header) that contains all of the plugin API in gtk-doc format.

Two headers because it's preferrable to group Scintilla related stuff
into its own namespace. This is a lot easier if g-ir-scanner can
work with a separate header file. If we change minds later on the script is
prepared to generate only one header.
2016-02-07 17:50:23 +01:00