|
|
Boost : |
Subject: Re: [boost] [multimethods] Proposal: Open Multi-Methods
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-08-01 06:50:53
> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Jean-Louis Leroy
> Sent: Wednesday, July 31, 2013 7:46 PM
> To: boost_at_[hidden]
> Subject: Re: [boost] [multimethods] Proposal: Open Multi-Methods
> > A good way to document is to write a Doxygen comment as you write your class, function, or macro
> prototype.
>
> I have used Doxygen in the past and I was happy with it. Not too sure it's the best way to document
> macros and templates, and one base class that contains only one pointer for internal use.
You can combine Doxygen comments with the text part in Quickbook to provide an automatically produced C++ reference section, including descriptions of templates and macros, and also add an auto-index to produce really nice documentation.
You can also provide examples which have embedded comments to ensure that the examples code actually compiles and runs.
Contact me privately if you would like help to get started with this process.
Paul
--- Paul A. Bristow, Prizet Farmhouse, Kendal LA8 8AB UK +44 1539 561830 07714330204 pbristow_at_[hidden]
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk