Snippetextractor comments in framework examples

Mirko Boehm mirko at
Mon Aug 18 09:10:35 UTC 2014


On 08/18/2014 09:50 AM, David Faure wrote:
> On Monday 11 August 2014 10:34:40 Rohan Garg wrote:
>> > Hi everyone
>> > As part of writing the KDE Frameworks 5 book, we were wondering if
>> > it's fine with all the framework maintainers if we started adding
>> > snippetextractor comments in the examples to be able to directly quote
>> > things in the book from the examples in the framework we're writing
>> > about.
> No objection. I wonder if this can be useful for the apidox too -- just like 
> Qt marks code for extraction into the api docs....

It should probably do this out of the box. Depending on the intended
output format, some minor changes may be required (specifying what
format is exptected, basically). At the moment it only produces Markdown
output, but Doxygen is able to process thart AFAIK.

The book and the threadweaver repo have some simple examples on how to
use the extractor.


Mirko Boehm | mirko at | KDE e.V.
FSFE Fellow, FSFE Team Germany
Qt Certified Specialist and Trainer

More information about the Kde-frameworks-devel mailing list