Geometry Boost List: [ggl] Documenting parameters

Subject: [ggl] Documenting parameters
From: Mateusz Loskot (mateusz)
Date: 2010-10-20 14:56:34

On 20/10/10 13:29, Barend Gehrels wrote:
>  hi Mateusz,
> 
> OK, nice you restarted. Most things we discussed on GT.

Yes, we've discussed. Most things are clear.

> I'm offline next days and keep this very short.

OK

>> The new version of documentation has merged the description of template
>> parameters with run-time call parameters. I am not convinced it's a good
>> idea. In the previous version, there were two tables: Template
>> parameters and Parameters.
>
> Until now I still think it a good idea, but giving the template
> parameters a hyperlink to their concept is a great idea.

Yes.

> What do others find?

Right, what folks thing?

>> in Boost.Asio. For instance:
>>
>> http://www.boost.org/doc/libs/1_44_0/doc/html/boost_asio/reference/async_read/overload1.html
>>
>>
>> Note, how neatly the templates are documented.
>
> Actually... I don't see a proper documentation of template parameters
> here...

I meant presentation: the type links to concept.

>> Name of template
>> parameter is a link to description of concept / requirements
>> which should be modelled by type passed to the template.
>
> Yep, great

Good.

Best regards,
-- 
Mateusz Loskot, http://mateusz.loskot.net
Charter Member of OSGeo, http://osgeo.org
Member of ACCU, http://accu.org