Joel de Guzman <joel@boost-consulting.com> 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.
But what about other tools? How about UML tools? Refactoring tools? Others, etc?
The all need a Wave front-end ;-) -- Dave Abrahams Boost Consulting www.boost-consulting.com