> On Tuesday, February 04, 2003 8:19 AM [GMT+1=CET], > Jeff Garland <[EMAIL PROTECTED]> wrote: > >> > Synopsis has tunable comment processors - you can make them as smart >> or as >> > dumb as you want them to be (it's Python, so it's easy ;-)). In my >> case, >> > the rule is simple - the comment describing the function appears as >> a solid >> > block right before its declaration with no intervening line >> > separation. >> >> Sorry I think I was unclear. I'm asking how a portion of that block >> is devoted to a specific portion of the description. For example: >> >> /** Brief description of function. >> Long description of function >> .... >> @return Describe the return value here. >> @pre precondition for the function >> @post postcondition for the function >> */ >> int f(); > > Nay, it was I who was unclear. How you do that is tunable. If you like > that style, you can use it. Personally, I would do something like this: > > // Brief description of function > // Long description of function > // ... > // > // Returns: Describe the return value here. > // Preconditions: precondition for the function > // Postconditions: postcondition for the function > // Throws: what it throws > // ... > > Because I want my comments to look like English ;-)
I highly agree. And I like that we can get the subsections (returns/preconditions/postconditions/etc) to follow those of the standard. Last I looked, Doxygen didn't have all the needed sections here. For this, and the fact that Synopsis could directly generate BoostBook, I think it might be the better solution. But I have no experience with it, and the setup scared me away last time ;). >> > > Also, as I recall >> > > last time I checked on Synopsis I had installation issues or some >> other difficulty -- that would have been shortly after the last >> committee meeting. >> > >> > I think I can help with that. Anyway, since I've just wiped my >> machine I'm >> > going to want to reinstall it myself, so we can experience the joys >> together ;-) >> >> You first ;-) > > Okey doke. And let us all know how to do this! ;) -- William E. Kempf [EMAIL PROTECTED] ------------------------------------------------------- This SF.NET email is sponsored by: SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See! http://www.vasoftware.com _______________________________________________ Boost-docs mailing list [EMAIL PROTECTED] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
