Re: Synopsis as documentation tool
Roman Yakovenko <[email protected]>
| Newsgroups | gmane.comp.documentation.synopsis |
|---|---|
| Message-ID | <[email protected]> |
On 12/12/05, Stefan Seefeld <[email protected]> wrote: > Hi Roman, > 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. Yes I do. This tutorial is really far from being complete: 1. How do I specify project name? 2. How do I tell Synopsis to work on whole package recursively? 3. What is the special syntax for comments\documentation string Synopsis uses? 4. How do I specify in documentation string the type of variable\argument? ( I would like to have some link to the variable class definition in generated documentation ) I understand that the best way to use Synopsis is to write my own Synopsis script, as is shown here http://synopsis.fresco.org/docs/Tutorial/script.html. But I would like to evaluate it first. > HTH, > Stefan Thanks Roman Yakovenko