-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On Tuesday 25 August 2009, Simonson, Lucanus J wrote:
Frank Mori Hess wrote:
Maybe the above isn't relevant to Boost.Polygon though, as I'm having difficulty telling what the library does from the online docs. A full tutorial instead of just a list of commented example code files might help new users a lot. Also, I cant find any documentation on what the names of the library's header files are or what they each contain.
What the library does is provide the core set of algorithms a person would need to write a CAD application for working with 2D polygons. Perhaps you will find the presentation from boostcon illuminating, since the link in the doc
Yes, that helped. I think adding a more fleshed-out version of the content in the presentation slides to the library's "real" documentation would improve it a lot.
into the header files to use the library. If you think it would be helpful I can add references to the relevant header files throughout the documentation.
There ought to be something like that. Presently, the only mention of header files I can find in the docs are that the example programs have a #include <boost/polygon/polygon.hpp> which presumably includes everything in the library. I was thinking of something like the reference sections of boostbook-generated docs, for example: http://www.boost.org/doc/libs/1_39_0/doc/html/accumulators/reference.html where you get a synopsis of the public api provided by each header. -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (GNU/Linux) iEYEARECAAYFAkqURqQACgkQ5vihyNWuA4V+TACg0kT0srCHzjkTDtIY99+arMlJ Bq0AoKewpJQSELAh8mdstuoRxN3yslNz =DyUH -----END PGP SIGNATURE-----