Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r79566 - trunk/libs/filesystem/doc/src
From: bdawes_at_[hidden]
Date: 2012-07-16 14:46:19


Author: bemandawes
Date: 2012-07-16 14:46:18 EDT (Mon, 16 Jul 2012)
New Revision: 79566
URL: http://svn.boost.org/trac/boost/changeset/79566

Log:
Continue work on docs, including description of C++11 strategy.
Text files modified:
   trunk/libs/filesystem/doc/src/boost_snippets.html | 79 ++++++++++++++++++++++++++++++++++++++-
   trunk/libs/filesystem/doc/src/source.html | 43 ++++++++++++---------
   2 files changed, 101 insertions(+), 21 deletions(-)

Modified: trunk/libs/filesystem/doc/src/boost_snippets.html
==============================================================================
--- trunk/libs/filesystem/doc/src/boost_snippets.html (original)
+++ trunk/libs/filesystem/doc/src/boost_snippets.html 2012-07-16 14:46:18 EDT (Mon, 16 Jul 2012)
@@ -22,7 +22,8 @@
   </tr>
 </table>
 
-<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
+<table border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse"
+ bordercolor="#111111" bgcolor="#D7EEFF" width="100%">
   <tr>
     <td>Filesystem Home &nbsp;&nbsp;
     <a href="release_history.html">Releases</a> &nbsp;&nbsp;
@@ -48,6 +49,80 @@
 <p>This reference documentation describes components that C++ programs may use
 to perform operations involving file systems, including paths, regular files,
 and directories.</p>
+
+<blockquote>
+<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse"
+ bordercolor="#111111" bgcolor="#D7EEFF" width="90%">
+ <tr>
+ <td width="100%" align="center" colspan="2">
+ <p align="center"><b>C++11 Support</b><p align="left">This reference
+ documentation is written as if all compilers supported C++11. Where
+ possible, the implementation falls back to C++03 if a C++11 feature is not
+ available.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="center">
+ <b>C++11 Feature</b></td>
+ <td width="65%" align="center">
+ <b>Action if not supported by compiler</b></td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ <code>noexcept</code></td>
+ <td width="65%" align="left">
+ Keyword omitted.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ <code>constexpr</code></td>
+ <td width="65%" align="left">
+ Keyword omitted.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ <p dir="rtl">R-value references</td>
+ <td width="65%" align="left">
+ Function signature omitted.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ New character types</td>
+ <td width="65%" align="left">
+ <p dir="ltr">The <code>boost::filesystem</code> interface doesn't use the
+ new types directly. It does use <code>u16string</code> and <code>u32string</code>
+ in namespace <code>boost</code>. These are typedefs to <code>std::u16string</code>
+ and <code>std::u32string</code> for C++11, or to <code>
+ std::basic_string&lt;boost::u16_t&gt;</code> and <code>
+ std::basic_string&lt;boost::u32_t&gt;</code> for C++03.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ Defaulted and deleted functions</td>
+ <td width="65%" align="left">
+ Workaround replacement functions provided.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ Initializer lists</td>
+ <td width="65%" align="left">
+ Not currently used.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ Variadic templates</td>
+ <td width="65%" align="left">
+ Not currently used.</td>
+ </tr>
+ <tr>
+ <td width="35%" align="left">
+ Range-based for statements</td>
+ <td width="65%" align="left">
+ Supporting functions always provided; they do no harm even for C++03
+ compilers.</td>
+ </tr>
+</table>
+</blockquote>
+
 $endid
 
 $id wording_suffix=
@@ -115,7 +190,7 @@
 </font>
 <a href="http://www.boost.org/LICENSE_1_0.txt"><font size="2">www.boost.org/LICENSE_1_0.txt</font></a></p>
 <p><font size="2">Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->20 March 2012<!--webbot bot="Timestamp" endspan i-checksum="27254" --></font></p>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B %Y" startspan -->16 July 2012<!--webbot bot="Timestamp" endspan i-checksum="18787" --></font></p>
 
 $endid
 

Modified: trunk/libs/filesystem/doc/src/source.html
==============================================================================
--- trunk/libs/filesystem/doc/src/source.html (original)
+++ trunk/libs/filesystem/doc/src/source.html 2012-07-16 14:46:18 EDT (Mon, 16 Jul 2012)
@@ -608,7 +608,8 @@
                            system::error_code&amp; ec);
 
     void copy_symlink(const path&amp; existing_symlink, const path&amp; new_symlink);
- void copy_symlink(const path&amp; existing_symlink, const path&amp; new_symlink, system::error_code&amp; ec);
+ void copy_symlink(const path&amp; existing_symlink, const path&amp; new_symlink,
+ system::error_code&amp; ec);
 
     bool create_directories(const path&amp; p);
     bool create_directories(const path&amp; p, system::error_code&amp; ec);
@@ -617,13 +618,16 @@
     bool create_directory(const path&amp; p, system::error_code&amp; ec);
 
     void create_directory_symlink(const path&amp; to, const path&amp; new_symlink);
- void create_directory_symlink(const path&amp; to, const path&amp; new_symlink, system::error_code&amp; ec);
+ void create_directory_symlink(const path&amp; to, const path&amp; new_symlink,
+ system::error_code&amp; ec);
 
     void create_hard_link(const path&amp; to, const path&amp; new_hard_link);
- void create_hard_link(const path&amp; to, const path&amp; new_hard_link, system::error_code&amp; ec);
+ void create_hard_link(const path&amp; to, const path&amp; new_hard_link,
+ system::error_code&amp; ec);
 
     void create_symlink(const path&amp; to, const path&amp; new_symlink);
- void create_symlink(const path&amp; to, const path&amp; new_symlink, system::error_code&amp; ec);
+ void create_symlink(const path&amp; to, const path&amp; new_symlink,
+ system::error_code&amp; ec);
 
     path current_path();
     path current_path(system::error_code&amp; ec);
@@ -668,7 +672,8 @@
     std::time_t last_write_time(const path&amp; p);
     std::time_t last_write_time(const path&amp; p, system::error_code&amp; ec);
     void last_write_time(const path&amp; p, const std::time_t new_time);
- void last_write_time(const path&amp; p, const std::time_t new_time, system::error_code&amp; ec);
+ void last_write_time(const path&amp; p, const std::time_t new_time,
+ system::error_code&amp; ec);
 
     path read_symlink(const path&amp; p);
     path read_symlink(const path&amp; p, system::error_code&amp; ec);
@@ -786,10 +791,10 @@
         template &lt;class Source&gt;
           path&amp; operator=(Source const&amp; source);
 
- template &lt;class Source&gt;
+$if $TARGET; == BOOST template &lt;class Source&gt;
           path&amp; assign(Source const&amp; source$CODECVT_ARG2;)
 
- template &lt;class InputIterator&gt;
+$endif; template &lt;class InputIterator&gt;
           path&amp; assign(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);
 
         // appends
@@ -798,10 +803,10 @@
         template &lt;class Source&gt;
           path&amp; operator/=(Source const&amp; source);
 
- template &lt;class Source&gt;
+$if $TARGET; == BOOST template &lt;class Source&gt;
           path&amp; append(Source const&amp; source$CODECVT_ARG2;);
 
- template &lt;class InputIterator&gt;
+$endif; template &lt;class InputIterator&gt;
           path&amp; append(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);
 
         // concatenation
@@ -813,9 +818,9 @@
           path&amp; operator+=(Source const&amp; x);
         template &lt;class CharT&gt;
           path&amp; operator+=(CharT x);
- template &lt;class Source&gt;
+$if $TARGET; == BOOST template &lt;class Source&gt;
           path&amp; concat(Source const&amp; x$CODECVT_ARG2;);
- template &lt;class InputIterator&gt;
+$endif; template &lt;class InputIterator&gt;
           path&amp; concat(InputIterator begin, InputIterator end);
         template &lt;class InputIterator&gt;
           path&amp; concat(InputIterator begin, InputIterator end$CODECVT_ARG2;);
@@ -961,10 +966,10 @@
 <h3> <a name="path-assignments"> <code>
 <font size="4">path</font></code> assignments</a> [path.assign]</h3>
 <pre>template &lt;class Source&gt;
- path&amp; operator=(Source const&amp; source);</pre>
-<pre>template &lt;class Source&gt;
- path&amp; assign(Source const&amp; source$CODECVT_ARG2;);</pre>
-<pre>template &lt;class InputIterator&gt;
+ path&amp; operator=(Source const&amp; source);
+$if $TARGET; == BOOST template &lt;class Source&gt;
+ path&amp; assign(Source const&amp; source$CODECVT_ARG2;);
+$endif; template &lt;class InputIterator&gt;
   path&amp; assign(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);</pre>
 <blockquote>
   <p><i>Effects:</i> Stores the contents [<code>begin</code>,<code>end</code>)
@@ -995,10 +1000,10 @@
   <p><i>Returns: </i><code>*this</code></p>
 </blockquote>
 <pre>template &lt;class Source&gt;
- path&amp; operator/=(Source const &amp; source);</pre>
-<pre>template &lt;class Source&gt;
- path&amp; append(Source const &amp; source$CODECVT_ARG2;);</pre>
-<pre>template &lt;class InputIterator&gt;
+ path&amp; operator/=(Source const &amp; source);
+$if $TARGET; == BOOST template &lt;class Source&gt;
+ path&amp; append(Source const &amp; source$CODECVT_ARG2;);
+$endif; template &lt;class InputIterator&gt;
   path&amp; append(InputIterator begin, InputIterator end$CODECVT_ARG2;$CODECVT_DEFAULT;);</pre>
 <blockquote>
   <p><i>Effects:</i></p>


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