[Qgis-developer] Call for applications: QGIS API Documentation Improvement

[Jürgen E. Fischer]

Hi Ale,

On Thu, 20. Aug 2015 at 11:42:06 +0200, Alessandro Pasotti wrote:
> Doxygen also accepts RST and we could place python documentation into .sip
> files, maybe a solution would be to include snippets and examples from
> doxygen (.sip is preferred) into the cookbook, leaving the introductory
> material in the cookbook itself interleaved with included examples and
> snippets.

The .sip are maintained by comparing them with the header files
(scripts/sipdiff).  So IMHO they should be kept as close to them as possible - 
at least in the section with the actual interfaces.  

But more verbose sections above or below the actual code shouldn't be a problem
(that part is mostly not in synced anyway).


Jürgen

-- 
Jürgen E. Fischer           norBIT GmbH             Tel. +49-4931-918175-31
Dipl.-Inf. (FH)             Rheinstraße 13          Fax. +49-4931-918175-50
Software Engineer           D-26506 Norden             http://www.norbit.de
QGIS release manager (PSC)  Germany                    IRC: jef on FreeNode                         
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 827 bytes
Desc: Digital signature
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20150820/e31ec417/attachment.pgp>