Boost logo

Boost :

From: Joel de Guzman (joel_at_[hidden])
Date: 2005-07-01 01:36:49


David Abrahams wrote:
> Joel de Guzman <joel_at_[hidden]> writes:
>
>
>>Rene Rivera wrote:
>>
>>>Joel de Guzman wrote:
>>>
>>>
>>>>2) Interfaces need to be documented. They need to be parsable
>>>> by an automatic documentation extraction tool such as
>>>> Doxygen or Synopsis.
>>>
>>>
>>>I don't know about Synopsis, but with Doxygen which I use for
>>>documenting my code. In my interfaces, mentioned long ago, macro IDL I
>>>just define the appropriate macros so that during documentation parsing
>>>things expand out to simple method declarations.
>>>
>>>Is that an acceptable avenue in your view?
>>
>>I suppose so, yes. Stefan also noted that Synopsos can also
>>be trained to understand macros.
>
>
> IIUC, he noted that no training is needed because the preprocessor
> expands the macros before the rest of Synopsis sees them.

<quote>
as far as synopsis is concerned I think it can be trained to
understand macros quite well
</quote>

>>But what about other tools?
>>How about UML tools? Refactoring tools? Others, etc?
>
>
> The all need a Wave front-end ;-)

Ok. Fair enough :-)

Regards,

-- 
Joel de Guzman
http://www.boost-consulting.com
http://spirit.sf.net

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk