|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r74754 - trunk/libs/filesystem/v3/doc
From: bdawes_at_[hidden]
Date: 2011-10-06 09:28:26
Author: bemandawes
Date: 2011-10-06 09:28:25 EDT (Thu, 06 Oct 2011)
New Revision: 74754
URL: http://svn.boost.org/trac/boost/changeset/74754
Log:
Add <pre> color, tweak some spacing
Text files modified:
trunk/libs/filesystem/v3/doc/reference.html | 45 ++++++++++++++++++++++++++++-----------
1 files changed, 32 insertions(+), 13 deletions(-)
Modified: trunk/libs/filesystem/v3/doc/reference.html
==============================================================================
--- trunk/libs/filesystem/v3/doc/reference.html (original)
+++ trunk/libs/filesystem/v3/doc/reference.html 2011-10-06 09:28:25 EDT (Thu, 06 Oct 2011)
@@ -8,6 +8,15 @@
<title>Filesystem V3 Reference
</title>
<link rel="stylesheet" type="text/css" href="../../../../doc/src/minimal.css">
+<style type="text/css">
+ pre {background-color:#D7EEFF}
+ body
+ {
+ font-family: sans-serif;
+ max-width : 8.5in;
+ margin: 1em;
+ }
+</style>
</head>
<body>
@@ -748,7 +757,7 @@
<h3> <a name="path-constructors"> <code>
<font size="4">path</font></code> constructors</a></h3>
-<pre>path();</pre>
+<pre><span style="background-color: #D7EEFF">path();</span></pre>
<blockquote>
<p><i>Postcondition:</i> <code>empty()</code>.</p>
</blockquote>
@@ -999,7 +1008,7 @@
<p><i>Returns:</i> <code>empty() ? path() : *--end()</code></p>
<p>[<i>Example:</i></p>
<blockquote>
- <pre><code>std::cout << path("/foo/bar.txt").filename();</code> // outputs "<code>bar.txt</code>" (without the quotes)</pre>
+ <pre><code>std::cout << path("/foo/bar.txt").filename();</code> // outputs "<code>bar.txt</code>"</pre>
</blockquote>
<p> <i>--end example</i>]</p>
</blockquote>
@@ -1013,8 +1022,8 @@
p.filename()</code>.</p>
<p>[<i>Example:</i></p>
<blockquote>
- <pre><code>std::cout << path("/foo/bar.txt").stem();</code> // outputs "<code>bar</code>" (without the quotes)</pre>
- <pre>path p = "foo.bar.baz.tar";
+ <pre><code>std::cout << path("/foo/bar.txt").stem();</code> // outputs "<code>bar</code>"
+path p = "foo.bar.baz.tar";
for (; !p.extension().empty(); p = p.stem())
std::cout << p.extension() << '\n';
// outputs: .tar
@@ -1035,7 +1044,7 @@
as alternate data streams or partitioned dataset names.</p>
<p>[<i>Example:</i></p>
<blockquote>
- <pre><code>std::cout << path("/foo/bar.txt").extension(); //</code> outputs "<code>.txt</code>" (without the quotes)</pre>
+ <pre><code>std::cout << path("/foo/bar.txt").extension(); //</code> outputs "<code>.txt</code>"</pre>
</blockquote>
<p> <i>--end example</i>]</p>
<p>[<i>Note:<b> </b></i>The dot is included in the return value so that
@@ -1246,7 +1255,8 @@
to ensure that paths with embedded spaces will round trip correctly. Ampersand (<code>&</code>)
is used as an escape character, so the path can itself contain double quotes.</p>
<pre>template <class Char, class Traits>
-std::basic_ostream<Char, Traits>& operator<<(std::basic_ostream<Char, Traits>& os, const path& p)
+std::basic_ostream<Char, Traits>& operator<<(std::basic_ostream<Char, Traits>& os,
+ const path& p)
</pre>
<blockquote>
<p><i>Effects:</i>
@@ -1256,7 +1266,8 @@
<code>os</code></p>
</blockquote>
<pre>template <class Char, class Traits>
-inline std::basic_istream<Char, Traits>& operator>>(std::basic_istream<Char, Traits>& is, path& p)
+inline std::basic_istream<Char, Traits>& operator>>(std::basic_istream<Char, Traits>& is,
+ path& p)
</pre>
<blockquote>
<p><i>Effects: </i>
@@ -1278,9 +1289,12 @@
public:
filesystem_error();
filesystem_error(const filesystem_error&);
- filesystem_error(const std::string& what_arg, system::error_code ec);
- filesystem_error(const std::string& what_arg, const path& p1, system::error_code ec);
- filesystem_error(const std::string& what_arg, const path& p1, const path& p2, system::error_code ec);
+ filesystem_error(const std::string& what_arg,
+ system::error_code ec);
+ filesystem_error(const std::string& what_arg,
+ const path& p1, system::error_code ec);
+ filesystem_error(const std::string& what_arg,
+ const path& p1, const path& p2, system::error_code ec);
filesystem_error& filesystem_error(const filesystem_error&);
~filesystem_error();
@@ -1405,6 +1419,7 @@
string.</p>
</blockquote>
<h3><a name="Class-directory_entry">Class <code>directory_entry</code></a></h3>
+<div dir="ltr">
<pre> namespace boost
{
namespace filesystem
@@ -1416,13 +1431,16 @@
// constructors and destructor
directory_entry();
directory_entry(const directory_entry&);
- explicit directory_entry(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());
+ explicit directory_entry(const path_type& p, file_status st=file_status(),
+ file_status symlink_st=file_status());
~directory_entry();
// modifiers
directory_entry& operator=(const directory_entry&);
- void assign(const path_type& p, file_status st=file_status(), file_status symlink_st=file_status());
- void replace_filename(const path& p, file_status st=file_status(), file_status symlink_st=file_status());
+ void assign(const path_type& p, file_status st=file_status(),
+ file_status symlink_st=file_status());
+ void replace_filename(const path& p, file_status st=file_status(),
+ file_status symlink_st=file_status());
// observers
const path& path() const;
@@ -1446,6 +1464,7 @@
} // namespace filesystem
} // namespace boost</pre>
+</div>
<p>A <code>directory_entry</code> object stores a <code>path object</code>,
a <code>file_status</code> object for non-symbolic link status, and a <code>
file_status</code> object for symbolic link status. The <code>file_status</code>
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