[Boost-bugs] [Boost C++ Libraries] #8144: Document locator and cached_location_t

Subject: [Boost-bugs] [Boost C++ Libraries] #8144: Document locator and cached_location_t
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-02-22 17:12:36

#8144: Document locator and cached_location_t
-------------------------------------+--------------------------------------
 Reporter:  mloskot                  |       Owner:  chhenning     
     Type:  Patches                  |      Status:  new           
Milestone:  To Be Determined         |   Component:  GIL           
  Version:  Boost Development Trunk  |    Severity:  Not Applicable
 Keywords:  documentation            |  
-------------------------------------+--------------------------------------
 I've stumbled upon old thread on
 [http://lists.boost.org/Archives/boost/2010/12/174157.php locator and
 cached_location_t]. There are some interesting explanations which I
 believe is worth to add to Boost.GIL docs.

 Particularly, I believe the following Lubomir's clarification should be
 added as first paragraph documenting cached location:

   ''Cached location is meant to be used as a quick way to get to
 neighborhood pixels if you need to read or write a neighboring location
 frequently relative to a given locator.''

 Currently, notion of cached location is documented in the
 [http://www.boost.org/doc/libs/1_51_0/libs/gil/doc/html/gildesignguide.html

 GIL design guide] but it makes users to deduce answer to '''What the
 cached locator is for?'''

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