|
Boost : |
Subject: Re: [boost] Improving Documentation
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2013-10-11 13:03:39
I haven't read all of this thread.. But I find Doxygen documentation
cumbersome and limited. For my Predef library I decided to extend quickbook
to let me more directly document the structure of Predef. Which is not easy
as it's *all* macro definitions. Perhaps my solutions could help the
general mixing of source & documentation. For example this <
http://www.boost.org/doc/libs/1_55_0b1/libs/predef/doc/html/predef/reference/version_definition_macros.html#predef.reference.version_definition_macros.boost_predef_make_macros>
come directly from <
https://github.com/grafikrobot/boost-predef/blob/master/include/boost/predef/make.h
>
On Fri, Oct 11, 2013 at 11:57 AM, Mathias Gaunard <
mathias.gaunard_at_[hidden]> wrote:
> On 11/10/13 15:31, TONGARI J wrote:
>
> I think Doxygen is fine for "regular" libraries, but I always have a
>> question: how could a library like Spirit be doucumented with it?
>>
>
> Same as any other library.
> You document the data types and the functions.
>
>
> ______________________________**_________________
> Unsubscribe & other changes: http://lists.boost.org/**
> mailman/listinfo.cgi/boost<http://lists.boost.org/mailman/listinfo.cgi/boost>
>
-- -- -- Grafik - Don't Assume Anything -- Redshift Software, Inc. - http://redshift-software.com -- rrivera/acm.org - grafik/redshift-software.com -- 102708583/icq - grafikrobot/aim - grafikrobot/yahoo
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk