|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r55448 - sandbox/gtl/doc
From: lucanus.j.simonson_at_[hidden]
Date: 2009-08-07 12:16:13
Author: ljsimons
Date: 2009-08-07 12:16:12 EDT (Fri, 07 Aug 2009)
New Revision: 55448
URL: http://svn.boost.org/trac/boost/changeset/55448
Log:
added operators namespace
Text files modified:
sandbox/gtl/doc/gtl_polygon_90_set_concept.htm | 1 +
sandbox/gtl/doc/gtl_polygon_set_concept.htm | 1 +
sandbox/gtl/doc/index.htm | 6 +++++-
3 files changed, 7 insertions(+), 1 deletions(-)
Modified: sandbox/gtl/doc/gtl_polygon_90_set_concept.htm
==============================================================================
--- sandbox/gtl/doc/gtl_polygon_90_set_concept.htm (original)
+++ sandbox/gtl/doc/gtl_polygon_90_set_concept.htm 2009-08-07 12:16:12 EDT (Fri, 07 Aug 2009)
@@ -84,6 +84,7 @@
constructor and assignment operator. The operator template exists to
eliminate temp copies of intermediate results when Boolean operators are chained
together.</p>
+<p>Operators are declared inside the namespace <font face="Courier New">boost::polygon::operators</font>.</p>
<table border="1" width="100%" id="table3">
<tr>
<td width="586"><font face="Courier New">template <typename T1, typename
Modified: sandbox/gtl/doc/gtl_polygon_set_concept.htm
==============================================================================
--- sandbox/gtl/doc/gtl_polygon_set_concept.htm (original)
+++ sandbox/gtl/doc/gtl_polygon_set_concept.htm 2009-08-07 12:16:12 EDT (Fri, 07 Aug 2009)
@@ -101,6 +101,7 @@
constructor and assignment operator. The operator template exists to
eliminate temp copies of intermediate results when Boolean operators are chained
together.</p>
+<p>Operators are declared inside the namespace <font face="Courier New">boost::polygon::operators</font>.</p>
<table border="1" width="100%" id="table5">
<tr>
<td width="586"><font face="Courier New">template <typename T1, typename
Modified: sandbox/gtl/doc/index.htm
==============================================================================
--- sandbox/gtl/doc/index.htm (original)
+++ sandbox/gtl/doc/index.htm 2009-08-07 12:16:12 EDT (Fri, 07 Aug 2009)
@@ -131,7 +131,11 @@
It is considerably more typing to describe this usage of the API than to code
it, and the description is not much clearer than the code itself.
Functions are named for what they do, or are overloads of C++ operators that make it
-easy to infer from reading the code what to expect from it. Following the
+easy to infer from reading the code what to expect from it. Operators are
+contained in the namespace <font face="Courier New">boost::polgyon::operators</font>
+so that they can be used outside the <font face="Courier New">boost::polygon</font>
+namespace without bringing in the entire <font face="Courier New">boost::polygon</font>
+namespace. Following the
principle of least astonishment, the inferred behavior should generally match
the actual behavior. Conventions such as argument ordering (output
arguments come first) and consistently applying the same semantics across
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk