Re: [Boost-users] Boost-wide concept docs
On 03/02/2011 17:52, Edward Diener wrote:
I have seen concepts mentioned in documentation for many Boost libraries but I never knew how to document a concept for what I myself may be working on. Does Boost specify a preferred common format for documenting a concept anywhere ?
Yes, caramel (that's an XML format). It integrates with boostbook and quickbook. See libs/concept_check/doc/reference for examples.
On 2/3/2011 4:39 PM, Mathias Gaunard wrote:
On 03/02/2011 17:52, Edward Diener wrote:
I have seen concepts mentioned in documentation for many Boost libraries but I never knew how to document a concept for what I myself may be working on. Does Boost specify a preferred common format for documenting a concept anywhere ?
Yes, caramel (that's an XML format). It integrates with boostbook and quickbook.
By common format I meant a common way of describing a concept, not a common physical file format ( like XML ). Sorry for the confusion of terms.
See libs/concept_check/doc/reference for examples.
I will look there.
At Thu, 03 Feb 2011 17:50:43 -0500, Edward Diener wrote:
On 2/3/2011 4:39 PM, Mathias Gaunard wrote:
On 03/02/2011 17:52, Edward Diener wrote:
I have seen concepts mentioned in documentation for many Boost libraries but I never knew how to document a concept for what I myself may be working on. Does Boost specify a preferred common format for documenting a concept anywhere ?
Yes, caramel (that's an XML format). It integrates with boostbook and quickbook.
By common format I meant a common way of describing a concept, not a common physical file format ( like XML ). Sorry for the confusion of terms.
By "an XML format" he means, essentially, a schema. XML:C++ as caramel:std::vector if you will. -- Dave Abrahams BoostPro Computing http://www.boostpro.com
participants (5)
-
Dave Abrahams -
Edward Diener -
Mathias Gaunard