Re: [Boost-docs] The beauty of LATEX

Subject: Re: [Boost-docs] The beauty of LATEX
From: Joel de Guzman (joel_at_[hidden])
Date: 2011-10-22 01:57:51

On 10/21/2011 7:51 PM, Mateusz Łoskot wrote:

> // Comment not dedicated to end-user documentation or API reference.
> // [function template_parameter_size
> //     nontype template function that just returns the template value.
> //     [parameter size is a constant integer argument
> //          [requires AnyNumberConcept<size>]]
> //     [argument Function expects no arguments]
> //     [return constant integer size always.
> //          [requires AnyNumberConcept<size>]]
> //     [precond No preconditions]
> //     [postcond No side effects]
> //     [nothrow]
> //     [warning This is not a very useful function]
> //     [note More useful functions]
> // ]
> // Does not compile with X. (Here another internal
> // comment not shown in API reference.)
> template <int size>
> int template_parameter_size()
> {
>    return size;
> }
> 
> Another rough examples
> 
> [concept BinaryFunction
>    [refines Assignable]
>    [refinedby None]
>    [related UnaryFunction]
>    [model `Result (*)(X, Y)` Pointer to function...] [/ model name
> wrapped with `` because contains spaces]
>    [notation
>       [F A type that is a model of BinaryFunction] [/no need to wrap F
> as `F` because it's solid token, no white spaces]
>       [X The first argument type of F]
>       [Result The result type of F]]
>    [expression f(x,y) Function call
>       [requires ...]
>       [returns ...]
>       [precond ...]
>       [semantic ....]
>       [postcond ...]]
>    [expression ...]
> ]
> 
> 
> [concept DefaultConstructivle
>    [refines None]
>    [notation
>       [X A type that is a model of DefaultConstructivle]
>       [x Object of type X]]
>    [model int]
>    [model std::vector<T>]
> ]
> 
> 
> What I like is reading such quickbook-wrapped comments is well aligned
> to reading natural language,
> With [] removed, story in English language remains.

I Luv it!

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