Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r71657 - in sandbox/local/libs/local/doc: html html/boost_local qbk
From: lorcaminiti_at_[hidden]
Date: 2011-05-01 19:06:58


Author: lcaminiti
Date: 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
New Revision: 71657
URL: http://svn.boost.org/trac/boost/changeset/71657

Log:
Fixed docs a bit.
Text files modified:
   sandbox/local/libs/local/doc/html/boost_local/Alternatives.html | 9 +++++----
   sandbox/local/libs/local/doc/html/boost_local/Bibliography.html | 4 ----
   sandbox/local/libs/local/doc/html/boost_local/Release_Notes.html | 37 +++++++++++++++++++++++++++++++++++--
   sandbox/local/libs/local/doc/html/index.html | 2 +-
   sandbox/local/libs/local/doc/qbk/alternatives.qbk | 8 ++++----
   sandbox/local/libs/local/doc/qbk/release_notes.qbk | 8 ++++++++
   6 files changed, 53 insertions(+), 15 deletions(-)

Modified: sandbox/local/libs/local/doc/html/boost_local/Alternatives.html
==============================================================================
--- sandbox/local/libs/local/doc/html/boost_local/Alternatives.html (original)
+++ sandbox/local/libs/local/doc/html/boost_local/Alternatives.html 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
@@ -193,17 +193,17 @@
               </td>
 <td>
                 <p>
- Yes.
+ Yes (plus the local function can be unnamed).
                 </p>
               </td>
 <td>
                 <p>
- Yes.
+ Yes (plus the local function can be unnamed).
                 </p>
               </td>
 <td>
                 <p>
- Yes.
+ Yes (plus the local function can be unnamed).
                 </p>
               </td>
 </tr>
@@ -289,7 +289,8 @@
 <td>
                 <p>
                   Yes (using <code class="computeroutput"><span class="identifier">let</span></code>
- which also allows to bind by constant reference).
+ which also allows to bind by constant reference, plus variables
+ in scope are accessible as usual within expressions).
                 </p>
               </td>
 </tr>

Modified: sandbox/local/libs/local/doc/html/boost_local/Bibliography.html
==============================================================================
--- sandbox/local/libs/local/doc/html/boost_local/Bibliography.html (original)
+++ sandbox/local/libs/local/doc/html/boost_local/Bibliography.html 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
@@ -51,10 +51,6 @@
       John Spicer. <span class="emphasis"><em>Local and Unamed Types as Template Arguments.</em></span>
       The C++ Standard Committee, document no. NN2657-08-0167, 2008.
     </p>
-<p>
- [StroustupGlossary]
- Bjarne Stroustrup. <span class="emphasis"><em>Bjarne Stroustrup's C++ Glossary.</em></span>
- </p>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 <td align="left"></td>

Modified: sandbox/local/libs/local/doc/html/boost_local/Release_Notes.html
==============================================================================
--- sandbox/local/libs/local/doc/html/boost_local/Release_Notes.html (original)
+++ sandbox/local/libs/local/doc/html/boost_local/Release_Notes.html 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
@@ -68,10 +68,43 @@
 <div class="titlepage"><div><div><h3 class="title">
 <a name="boost_local.Release_Notes.todo"></a><a class="link" href="Release_Notes.html#boost_local.Release_Notes.todo" title="TODO">TODO</a>
 </h3></div></div></div>
-<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+ Add Inline Local Function <code class="computeroutput"><span class="special">...</span><span class="identifier">_NAME</span><span class="special">(</span><span class="keyword">inline</span> <span class="special">&lt;</span><span class="identifier">name</span><span class="special">&gt;)</span></code>
+ to Advanced Topics section.
+ </li>
+<li class="listitem">
+ Add <code class="computeroutput"><span class="special">...</span><span class="identifier">_NAME</span><span class="special">(</span><span class="identifier">recursive</span>
+ <span class="special">&lt;</span><span class="identifier">name</span><span class="special">&gt;)</span></code> to recursion section in Advanced
+ Topics. Indicate that recursive local function cannot be optimized even
+ when declared inline.
+ </li>
+<li class="listitem">
+ Modify <code class="computeroutput"><span class="special">...</span><span class="identifier">_NAME</span><span class="special">()</span></code> macro to parse also <code class="computeroutput"><span class="identifier">recursive</span>
+ <span class="keyword">inline</span></code> and <code class="computeroutput"><span class="keyword">inline</span>
+ <span class="identifier">recursive</span></code> as recursive (no
+ reason to give an error, just ignore the inline request and document
+ it).
+ </li>
+<li class="listitem">
+ Document recursive, inline, and that recursive is never inlined in <code class="computeroutput"><span class="special">...</span><span class="identifier">_NAME</span><span class="special">()</span></code> Doxygen.
+ </li>
+<li class="listitem">
+ Document limitation that inline local functions cannot be assigned to
+ <code class="computeroutput"><span class="identifier">local</span><span class="special">::</span><span class="identifier">function</span></code> and therefore they cannot
+ be passed as function parameters, etc.
+ </li>
+<li class="listitem">
+ Rework factorial_impl and Implementation section.
+ </li>
+<li class="listitem">
+ Read all N-papers about "passing local types as template parameters".
+ </li>
+<li class="listitem">
             <span class="bold"><strong>Code.</strong></span> Optimize macro expansion code
             for C++0x, C++03, etc. From John Bytheway:
- </li></ol></div>
+ </li>
+</ol></div>
 <pre class="programlisting"><span class="special">&gt;</span> <span class="identifier">Yes</span><span class="special">,</span> <span class="identifier">in</span> <span class="identifier">C</span><span class="special">++</span><span class="number">0</span><span class="identifier">x</span> <span class="identifier">local</span> <span class="identifier">structs</span> <span class="identifier">can</span> <span class="identifier">be</span> <span class="identifier">passed</span> <span class="identifier">as</span> <span class="keyword">template</span> <span class="identifier">parameters</span><span class="special">.</span>
 <span class="special">&gt;</span> <span class="identifier">Obviously</span><span class="special">,</span> <span class="identifier">in</span> <span class="identifier">C</span><span class="special">++</span><span class="number">0</span><span class="identifier">x</span> <span class="identifier">there</span> <span class="identifier">are</span> <span class="identifier">lambdas</span> <span class="identifier">too</span><span class="special">,</span> <span class="identifier">so</span> <span class="identifier">you</span> <span class="identifier">might</span> <span class="identifier">think</span> <span class="identifier">your</span>
 <span class="special">&gt;</span> <span class="identifier">library</span> <span class="identifier">is</span> <span class="identifier">useless</span><span class="special">,</span> <span class="identifier">but</span> <span class="identifier">I</span> <span class="identifier">would</span> <span class="identifier">expect</span> <span class="identifier">most</span> <span class="identifier">compilers</span> <span class="identifier">to</span> <span class="identifier">support</span> <span class="identifier">passing</span>

Modified: sandbox/local/libs/local/doc/html/index.html
==============================================================================
--- sandbox/local/libs/local/doc/html/index.html (original)
+++ sandbox/local/libs/local/doc/html/index.html 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
@@ -416,7 +416,7 @@
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: May 01, 2011 at 21:58:12 GMT</small></p></td>
+<td align="left"><p><small>Last revised: May 01, 2011 at 23:05:54 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Modified: sandbox/local/libs/local/doc/qbk/alternatives.qbk
==============================================================================
--- sandbox/local/libs/local/doc/qbk/alternatives.qbk (original)
+++ sandbox/local/libs/local/doc/qbk/alternatives.qbk 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
@@ -50,9 +50,9 @@
     [ No. It can be defined only within declarations. ]
     [ No. It can be defined only within declarations. ]
     [ No. It can be defined only within declarations. ]
- [ Yes. ]
- [ Yes. ]
- [ Yes. ]
+ [ Yes (plus the local function can be unnamed). ]
+ [ Yes (plus the local function can be unnamed). ]
+ [ Yes (plus the local function can be unnamed). ]
 ]
 [
     [ ['Can be passed as template parameter (e.g., to STL algorithms)] ]
@@ -76,7 +76,7 @@
     In addition, there is "short-hand" syntax to bind all variables in scope at once (by value or by reference).
 However, it is not possible to bind by constant reference (only by constant value). ]
     [ No (but variables in scope are accessible as usual within expressions). ]
- [ Yes (using `let` which also allows to bind by constant reference). ]
+ [ Yes (using `let` which also allows to bind by constant reference, plus variables in scope are accessible as usual within expressions). ]
 ]
 ]
 

Modified: sandbox/local/libs/local/doc/qbk/release_notes.qbk
==============================================================================
--- sandbox/local/libs/local/doc/qbk/release_notes.qbk (original)
+++ sandbox/local/libs/local/doc/qbk/release_notes.qbk 2011-05-01 19:06:57 EDT (Sun, 01 May 2011)
@@ -35,6 +35,14 @@
 
 # Modify `..._NAME()` macro to parse also `recursive inline` and `inline recursive` as recursive (no reason to give an error, just ignore the inline request and document it).
 
+# Document recursive, inline, and that recursive is never inlined in `..._NAME()` Doxygen.
+
+# Document limitation that inline local functions cannot be assigned to `local::function` and therefore they cannot be passed as function parameters, etc.
+
+# Rework factorial_impl and Implementation section.
+
+# Read all N-papers about "passing local types as template parameters".
+
 # *Code.* Optimize macro expansion code for C++0x, C++03, etc.
 From John Bytheway:
 


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