Re: Re: Can synopsis (be made to) follow Python imports?

Vicki Brown wrote:
> Has anyone looked at Doxygen?
>     http://www.stack.nl/~dimitri/doxygen/

We have used Doxygen for 2-3 years on at least two different projects. 
The larger project is around 250 KSLOC of C++, and the smaller project 
is around 40 KSLOC of C++.  On top of that, both projects provide Python 
interfaces, so we write documentation for both C++ and Python 
developers/users.

I am not criticizing Doxygen here.  Doxygen is a fine product, and it 
can do a lot for you.  However, we've had to muck with it A LOT in order 
to generate our Python docs.  Our solution works well enough, but it's 
fragile and difficult to maintain.  It's certainly not something we're 
proud of.  We are experimenting with Synopsis now, because we think 
it'll provide a better alternative than Doxygen.  The jury's still out, 
but at the moment Synopsis looks like it'll work much better for us than 
does Doxygen.

> The only drawback is that, in order to make Doxygen work on Python, I
> have to cause it to run the source code through a filter that
> converts all of the Python source to pseudo-C++. The results are very
> much what I want to see. Extremely complete and extensive. But all of
> the source 'looks" like C++ :-(

If Doxygen works for you, that's great.  As I said, it's a fine product. 
  However, I'd caution you first to spend A LOT of time testing your 
Python->C++ converter.  You're going to have to live with it for a long 
time, and there may be numerous hidden gotchas.

Rick
-- 
Richard M Kelly                             [email protected]
[PGP  =>  D5 C3 CC D2 B7 D0 A9 B0  D5 90 B2 55 5A 80 23 B6  FC AB 67 B4]