[Boost-bugs] [Boost C++ Libraries] #9947: Manual improvements

Subject: [Boost-bugs] [Boost C++ Libraries] #9947: Manual improvements
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2014-04-24 08:15:16

#9947: Manual improvements
-------------------------------+----------------------------
 Reporter:  sebastien.kramm@…  |      Owner:  barendgehrels
     Type:  Feature Requests   |     Status:  new
Milestone:  To Be Determined   |  Component:  geometry
  Version:  Boost 1.55.0       |   Severity:  Not Applicable
 Keywords:                     |
-------------------------------+----------------------------
 New to boost geometry, I had some trouble with the sample code in the
 manual

 On bottom of "quick start" page:
 http://www.boost.org/doc/libs/1_55_0/libs/geometry/doc/html/geometry/spatial_indexes/rtree_examples/quick_start.html,

 there two lines of codes that call some 'wkt' function:
     `bg::wkt<box>(v.first)`

 However, there isn't anything named wkt neither in matrix reference:
 http://www.boost.org/doc/libs/1_55_0/libs/geometry/doc/html/geometry/indexes/matrix.html

 neither in aphabetical index:
 http://www.boost.org/doc/libs/1_55_0/libs/geometry/doc/html/geometry/indexes/alphabetical_index.html


 After spending some time Googling, I finally realize that this seems to be
 related to this:
 http://en.wikipedia.org/wiki/Well-known_text


 Indeed there are some headers that define this:
 http://www.boost.org/doc/libs/1_55_0/boost/geometry/io/wkt/


 Strangely, the file:
 http://www.boost.org/doc/libs/1_55_0/boost/geometry/io/wkt/read.hpp

 has some Doxygen documentation, but it does not appear in the final
 manual. Got lost in the Doxygen to QuickBook process ?

 I finally found this 'wkt' page:
 http://www.boost.org/doc/libs/1_55_0/libs/geometry/doc/html/geometry/reference/io/wkt.html

 but it is empty.

 I feel that this could be improved, especially for the newcomer. Would it
 be possible to re-enable the doxygen-style documentation into the
 published manual ? Along to some explanation of what all this wkt thing
 is, and and links in the index.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/9947>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.