Re: [Boost-docs] Using automatic doxygen documentation with Boost Concept Check

Subject: Re: [Boost-docs] Using automatic doxygen documentation with Boost Concept Check
From: Mathias Gaunard (mathias.gaunard_at_[hidden])
Date: 2009-07-30 17:22:35

Daniel James wrote:
> 2009/7/30 Mathias Gaunard <mathias.gaunard_at_[hidden]>:
>> I am running into a few problems with the automatic doxygen documentation of
>> my library after adding concept checking to it.
>>
>> First, the documentation (I don't know which of doxygen or boostbook is at
>> fault) seems to fail miserably -- and by that I mean random private members
>> being documented as namespace level globals -- if BOOST_CONCEPT_REQUIRES is
>> not expanded.
>> The default expanding is not really nice for a reference documentation, so
>> if anyone knows of a definition of BOOST_CONCEPT_REQUIRES that plays nice
>> please tell me. For now I'm using "BOOST_CONCEPT_REQUIRES(a, b)=/**
>> Requires: a */ b ".
> 
> It's hard to say since I don't use concept check, or doxygen for that
> matter. Can you point me towards an example that I can try building?

You can try building the docs of my unicode library on the sandbox.
run bjam in boost-sandbox/SOC/2009/unicode/libs/unicode/doc/

Edit Jamfile.v2 to remove the doxygen-specific definition of 
BOOST_CONCEPT_REQUIRES that I gave above.

Then you can look at the reference of the 
<boost/iterator/consumer_iterator.hpp> header for example and see some 
bogus results.