Re: [pygccxml-development] C++ wiki like editor using pygccxml

[Roman Y. <rom...@gm...>]

On 8/21/06, rodrigo benenson <rod...@gm...> wrote:
> Hi there,
> I'm wondering if it is possible to do the link between the parsed C++
> code and the original source code file when using pygccxml.

Yes of course, see next documents:
http://svn.sourceforge.net/viewvc/pygccxml/pyplusplus_dev/docs/documentation/doc_string.rest?view=markup

And some source code:
http://svn.sourceforge.net/viewvc/pygccxml/pygccxml_dev/pygccxml/declarations/declaration.py?view=markup

For every declaration, except namespace, pygccxml provides via
"location" property: full file name and line number

> The idea would be to create a wikiwiki like editor for C++ code documentation.
> Using a python C++ parser I could transform the source code into an
> HTML representation, to render the documentation web page.
>
> Then using the web interface the user could edit the comments in the
> C++ source code to enhance the documentation (using a doxygen like
> syntax).
>
> Of course a database could be created and maintained on the flight to
> provide cross references to different definitions in the source code.
>
> The most difficult aspect of the idea seems to actually be able to
> parse the C++ files and make the link between the definitions, the
> comments and they actual position in the source code.

There are few other: macros and templates

> Do you thing it is possible to create such documentation system with
> the existing tools ?

Decide yourself. GCC-XML does not provide information about function
bodies and expression,
only about declarations. May be this is enough may be not. May be the
better way to go is:
doxygen. It parsers C++ source files and dumps the information to xml
files. So users will be able
to comment implementation too.


-- 
Roman Yakovenko
C++ Python language binding
http://www.language-binding.net/