Re: Confused about Synopsis

Stefan Seefeld <[email protected]> Sun, 19 Aug 2007 11:17:40 -0400
Newsgroups gmane.comp.documentation.synopsis
Message-ID <[email protected]>
David Piepgrass wrote:
> Hi, I'm having trouble figuring out what Synopsis can be used for.
> 
> Firstly, can it be used as a replacement for Doxygen? Where is the

Yes.

> documentation for Synopsis's documentation generator?

http://synopsis.fresco.org/docs/

> Secondly, I installed synopsis-0.8.win32-py2.4.exe on my Windows
> computer, but there is no executable called synopsis anywhere on my
> computer. It's discussed in the documentation; where is it?

Under windows the script is called 'synopsis.py'. The installation script
should generate a list of all installed files, which you should be able
to look at through some system tools. (Sorry, I'm not using windows
often enough to be more specific.)

> Thirdly, I would like to have a tool that makes C++-to-C++ wrappers in
> order to create C++ dynamic-link libraries. My idea is to convert header
> files that are full of low-level details about a library into another
> set of header files that only have high-level details.

[...]

> Would Synopsis be suitable for this purpose? Another way I could do this
> is by extending SWIG (www.swig.org) but in my research so far, it feels
> like an extremely complex tool to write code for.

Yes, Synopsis may be used for that. You may inspect the AST and generate
code from that (by implementing your own Synopsis.AST.Visitor). This would
typically be done in a Synopsis processor (a 'formatter', specifically), which
you then call as any other processor. See
http://synopsis.fresco.org/docs/Tutorial/script.html#extending.

If the AST doesn't provide enough details, you may also inspect the parse
tree, but that requires some C++ coding, as the parse tree is only available
as a C++ API.

Let me know whether you need more info to get started,

		Stefan

-- 

      ...ich hab' noch einen Koffer in Berlin...