Re: Synopsis as documentation tool

Tom Russell wrote:
> I looked into using Synopsis to generate control-flow diagrams as 
> documentation for C code. This was a while back. I didn't get far, as I was 
> waiting for an engineer at work to show me how it might be useful. The last 
> news I got was that, since our code uses function pointers extensively, that 
> this probably wouldn't be worth the effort. I assume this is correct.

Right. Synopsis presently doesn't provide the required analysis, though
something like that would be a very useful extension. As always, contributions
are very much appreciated.

> I see  that there could be other documentation generated from it much like 
> what JavaDoc or Doxygen produces (structure dependency diagrams being the 
> coolest, in my opinion). I'm just guessing, though, about Synopsis as I 
> haven't read the documentation and must ask to be excused for any ignorance. 
> Just the idea of an abstract syntax tree with a Python interface is pretty 
> cool, anyway, and means there must be a lot of different potential uses.

Indeed. In fact, I'm presently working on a new and 'more correct' C++ parser,
with a solidified parse tree API that will be exposed to python, too.

With that you will be able to get very fine-grained control over source code
manipulation, which is useful for source-to-source translation (Hi Roman ;-).

Regards,
		Stefan