Re: Synopsis as documentation tool
Tom Russell <[email protected]>
| Newsgroups | gmane.comp.documentation.synopsis |
|---|---|
| Message-ID | <[email protected]> |
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. 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. -TR wOn Sun December 11 2005 10:25 pm, Stefan Seefeld wrote: > Hi Roman, > > Roman Yakovenko wrote: > > Hi. I would like to use Synopsis as source code documentation tool. > > But I have small problem: > > I can not find documentation\references how to do this. > > Did you read the tutorial at > http://synopsis.fresco.org/docs/Tutorial/index.html ? While far from > complete, it should definitely get you started. Please don't hesitate if > you have specific questions. > > HTH, > Stefan > > _______________________________________________ > Synopsis-devel mailing list > [email protected] > http://lists.fresco.org/cgi-bin/listinfo/synopsis-devel