[Insight-users] tool used to generate software guide?

[Karthik Krishnan]

Juan:

You may find these in InsightDocuments/

  cvs -d:anonymous at www.itk.org:/cvsroot/Insight co InsightDocuments

Its a bunch of cmake driven
- perl scripts to parse the source code and extract the relevant comments
- perl script to run the relevant binaries of each source code with
the command line tags present in the top of the source file to
generate the output images. These generated output images are then
included from ITK's binary tree directly into appropriate
\includegraphics tags software guide. This way if the algorithms
change, the images in the guide change as well :) . The perl script
also generates cmake dependencies to ensure that the right examples
run before others, for instance if one example generates an image
that's an input to another
- Finally cmake drives latex, dvips, ps2pdf to generate the output document.

--
karthik

On Tue, Nov 9, 2010 at 5:35 PM, Juan Cardelino <juan.cardelino at gmail.com> wrote:
> Hello guys,
>                 I'm interested in documenting my code in the same way
> as ITK. That is, to place comments in the code possibly with latex
> syntax, and then extract it, compile with latex and generate a pdf. In
> addition, it would be nice to extract certain parts of the code and
> place them in the document as in the software guide. Is there a
> standard open source tool to do this? or do you guys use your own hand
> crafted parser?
> Thanks in advance.
> Best,
>       Juan
> _____________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://www.kitware.com/products/protraining.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-users
>