Geometry Boost List: [ggl] Documenting parameters

Subject: [ggl] Documenting parameters
From: Barend Gehrels (barend.gehrels)
Date: 2010-10-20 08:28:47

  hi Mateusz,

OK, nice you restarted. Most things we discussed on GT.

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

> 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.
What do others find?

> I think it would be good to separate them. I like how it is done
> 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...
> Name of template
> parameter is a link to description of concept / requirements
> which should be modelled by type passed to the template.
Yep, great

Regards, Barend

-- 
-------------------------------------
Barend Gehrels
-------------------------------------
http://www.erplex.com
http://trac.osgeo.org/ggl
http://www.geodan.nl
-------------------------------------
Geodan
President Kennedylaan 1
1079 MB Amsterdam
The Netherlands
-------------------------------------
Tel: [phone]
Mob: [phone]
Fax: [phone]
-------------------------------------
E-mail: barend.gehrels_at_[hidden]
Kvk-nummer: 33 207089
Disclaimer: www.geodan.nl/disclaimer
-------------------------------------