Re: [Boost-docs] [quickbook] Does import work?

Subject: Re: [Boost-docs] [quickbook] Does import work?
From: Joel de Guzman (joel_at_[hidden])
Date: 2011-10-17 02:01:36


On 10/17/2011 4:46 AM, Dave Abrahams wrote:
>
> on Sun Oct 16 2011, Rene Rivera <grafikrobot-AT-gmail.com> wrote:
>
>> On 10/16/2011 11:38 AM, Daniel James wrote:
>>> On Sunday, 16 October 2011, Rene Rivera wrote:
>>
>>>>
>>>>
>>>> Right. I'm trying to have "[import ..]" work as easy as Doxygen does, but
>>>> for quickbook. As documenting the library I'm working on would otherwise be
>>>> a serious PITA. And I'd rather avoid using Doxygen for it as it's much
>>>> easier to deal with quickbook directly. Ultimately I want to be able to:
>>>>
>>>> ===
>>>> [import boost/predef/*.h]
>>>> [import boost/predef/*/*.h]
>>>> [import boost/predef/*/*/*.h]
>>>> ===
>>>>
>>>> And have all the documentation that's embedded in those source files
>>>> injected into the quickbook stream. Without me having to maintain what the
>>>> files are, or what they contain.
>>>>
>>>
>>> So you don't want to include the whole headers, just the documentation
>>> embedded in them?
>>
>> Right.
>>
>>> This feels like a bit of an odd thing to do in quickbook
>>> itself,
>>
>> Is it any odder than the existing import facility?
>
> Seems like a natural bit of Literate Programming functionality to me.

Looks good to me. I like the idea. I also have a big dislike for Doxygen.

(Been in lurk mode recently)

Regards,

-- 
Joel de Guzman
http://www.boostpro.com
http://boost-spirit.com

This archive was generated by hypermail 2.1.7 : 2017-11-11 08:50:41 UTC