|
Boost : |
Subject: [boost] [geometry] Documentation prototype for review
From: Mateusz Loskot (mateusz_at_[hidden])
Date: 2010-02-13 19:38:00
Hi,
I'm working on documentation of Boost Geometry based on Quickbook
and I've prepared a prototype:
http://mateusz.loskot.net/tmp/ggl/qbk/
What I'm doing is manually porting the content from Doxygen-based
(http://geometrylibrary.geodan.nl/) plus restructuring, reformatting
and completing it with missing details.
I'd like to ask everyone who is interested in Boost Geometry library
for comments, impressions and suggestions of improvements.
Note, nodes marked with (?) are not finished and empty, but
included to give impression about the overall structure.
I'd be especially interested comments about the structure, if it's
accessible to new users and usable for advanced users at the same time.
The Reference is one of the most important section I'd like to master,
so please share your comments on the form and completeness of the
concepts specification, for example:
http://mateusz.loskot.net/tmp/ggl/qbk/geometry/reference/geometries/concepts/point.html
types description, for example:
http://mateusz.loskot.net/tmp/ggl/qbk/geometry/reference/geometries/types/points.html
and functions description:
http://mateusz.loskot.net/tmp/ggl/qbk/geometry/reference/arithmetic/add_point.html
Thanks in advance for your feedback.
Best regards,
-- Mateusz Loskot, http://mateusz.loskot.net Charter Member of OSGeo, http://osgeo.org
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk