|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r54607 - in sandbox/cloneable/libs/cloneable/doc: . html html/cloneable html/cloneable/tutorial
From: christian.schladetsch_at_[hidden]
Date: 2009-07-03 07:35:23
Author: cschladetsch
Date: 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
New Revision: 54607
URL: http://svn.boost.org/trac/boost/changeset/54607
Log:
udpated docs
Text files modified:
sandbox/cloneable/libs/cloneable/doc/cloneable.qbk | 31 ++++++++++++++++++-------------
sandbox/cloneable/libs/cloneable/doc/html/cloneable/change_log.html | 4 ++--
sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial.html | 17 +++++++++++------
sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/customising_the_cloning_process.html | 2 +-
sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/simple_hierarchical_cloning.html | 4 ++--
sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_custom_allocators.html | 2 +-
sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_external_types.html | 2 +-
sandbox/cloneable/libs/cloneable/doc/html/index.html | 6 +++---
8 files changed, 39 insertions(+), 29 deletions(-)
Modified: sandbox/cloneable/libs/cloneable/doc/cloneable.qbk
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/cloneable.qbk (original)
+++ sandbox/cloneable/libs/cloneable/doc/cloneable.qbk 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -61,7 +61,7 @@
[endsect]
-[section:tutorial Basic Usage]
+[section:tutorial Tutorial]
This tutorial progresses through the basic usage of the library, demonstrating how
to make a new Cloneable type, how to make an exsiting, external type Cloneable,
@@ -70,7 +70,7 @@
The following is a very quick introduction to [*Boost.Cloneable]:
``
-#include <boost/cloneable.hpp>;
+#include <boost/cloneable.hpp>
using namespace boost;
@@ -86,8 +86,13 @@
``
Here we have made a class and derived from `cloneable::base`, passing the
-type of thing to clone as a type parameter. Because we didn't supply a base
-type to use, we were given `default_base_type`. Although it is fine to use
+type of thing to clone as a parameter.
+
+Because we didn't supply a base
+type to use, we were given `default_base_type`, which is the return type of the clone
+method.
+
+Although it is fine to use
this default base class, we shall see that in general it is better to provide
our own base classes as this gives us much flexibility when it comes to
associative containers and resource management.
@@ -422,9 +427,9 @@
typedef heterogenous::list<Animal> List;
List list;
-list.push_back<Cat>("sam", 12);
-list.push_back<Dog>("spot", 8);
-list.push_back<Labrador>("max", 14);
+list.emplace_back<Cat>("sam", 12);
+list.emplace_back<Dog>("spot", 8);
+list.emplace_back<Labrador>("max", 14);
List copy = list;
@@ -455,9 +460,9 @@
``
typedef heterogenous::vector<Animal> Vector;
Vector vector;
-vector.push_back<Cat>("sam");
-vector.push_back<Dog>("spot");
-vector.push_back<Labrador>("max", 14);
+vector.emplace_back<Cat>("sam");
+vector.emplace_back<Dog>("spot");
+vector.emplace_back<Labrador>("max", 14);
Vector copy = vector;
@@ -479,9 +484,9 @@
typedef heterogenous::set<Animal> Set;
Set set;
- Cat &sam = set.insert<Cat>("sam", 1.5);
- Dog &spot = set.insert<Dog>("spot", 3);
- Labrador &max = set.insert<Labrador>("max", 14);
+ Cat &sam = set.emplace<Cat>("sam", 1.5);
+ Dog &spot = set.emplace<Dog>("spot", 3);
+ Labrador &max = set.emplace<Labrador>("max", 14);
Set copy = set;
Modified: sandbox/cloneable/libs/cloneable/doc/html/cloneable/change_log.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/cloneable/change_log.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/change_log.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -7,7 +7,7 @@
<link rel="home" href="../index.html" title="Cloneable 0.1">
<link rel="up" href="../index.html" title="Cloneable 0.1">
<link rel="prev" href="intro.html" title="Introduction">
-<link rel="next" href="tutorial.html" title="Basic Usage">
+<link rel="next" href="tutorial.html" title="Tutorial">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
@@ -27,7 +27,7 @@
<a name="cloneable.change_log"></a><a class="link" href="change_log.html" title="Change Log"> Change Log</a>
</h2></div></div></div>
<a name="cloneable.change_log.version_0_1"></a><h4>
-<a name="id666656"></a>
+<a name="id660103"></a>
<a class="link" href="change_log.html#cloneable.change_log.version_0_1">Version 0.1</a>
</h4>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
Modified: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -1,7 +1,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>Basic Usage</title>
+<title>Tutorial</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../index.html" title="Cloneable 0.1">
@@ -22,9 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="change_log.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial/simple_hierarchical_cloning.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Basic Usage">
+<div class="section" title="Tutorial">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="cloneable.tutorial"></a><a class="link" href="tutorial.html" title="Basic Usage"> Basic Usage</a>
+<a name="cloneable.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial"> Tutorial</a>
</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="tutorial/simple_hierarchical_cloning.html">Simple
@@ -47,7 +47,7 @@
<p>
</p>
-<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">cloneable</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">>;</span>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">cloneable</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">;</span>
@@ -65,8 +65,13 @@
</p>
<p>
Here we have made a class and derived from <code class="computeroutput"><span class="identifier">cloneable</span><span class="special">::</span><span class="identifier">base</span></code>, passing
- the type of thing to clone as a type parameter. Because we didn't supply a
- base type to use, we were given <code class="computeroutput"><span class="identifier">default_base_type</span></code>.
+ the type of thing to clone as a parameter.
+ </p>
+<p>
+ Because we didn't supply a base type to use, we were given <code class="computeroutput"><span class="identifier">default_base_type</span></code>,
+ which is the return type of the clone method.
+ </p>
+<p>
Although it is fine to use this default base class, we shall see that in general
it is better to provide our own base classes as this gives us much flexibility
when it comes to associative containers and resource management.
Modified: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/customising_the_cloning_process.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/customising_the_cloning_process.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/customising_the_cloning_process.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -5,7 +5,7 @@
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../../index.html" title="Cloneable 0.1">
-<link rel="up" href="../tutorial.html" title="Basic Usage">
+<link rel="up" href="../tutorial.html" title="Tutorial">
<link rel="prev" href="using_external_types.html" title="Using External Types">
<link rel="next" href="using_custom_allocators.html" title="Using Custom Allocators">
</head>
Modified: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/simple_hierarchical_cloning.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/simple_hierarchical_cloning.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/simple_hierarchical_cloning.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -5,8 +5,8 @@
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../../index.html" title="Cloneable 0.1">
-<link rel="up" href="../tutorial.html" title="Basic Usage">
-<link rel="prev" href="../tutorial.html" title="Basic Usage">
+<link rel="up" href="../tutorial.html" title="Tutorial">
+<link rel="prev" href="../tutorial.html" title="Tutorial">
<link rel="next" href="using_external_types.html" title="Using External Types">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Modified: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_custom_allocators.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_custom_allocators.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_custom_allocators.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -5,7 +5,7 @@
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../../index.html" title="Cloneable 0.1">
-<link rel="up" href="../tutorial.html" title="Basic Usage">
+<link rel="up" href="../tutorial.html" title="Tutorial">
<link rel="prev" href="customising_the_cloning_process.html" title="Customising the Cloning Process">
<link rel="next" href="../containers.html" title="Containers">
</head>
Modified: sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_external_types.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_external_types.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/cloneable/tutorial/using_external_types.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -5,7 +5,7 @@
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="../../index.html" title="Cloneable 0.1">
-<link rel="up" href="../tutorial.html" title="Basic Usage">
+<link rel="up" href="../tutorial.html" title="Tutorial">
<link rel="prev" href="simple_hierarchical_cloning.html" title="Simple Hierarchical Cloning">
<link rel="next" href="customising_the_cloning_process.html" title="Customising the Cloning Process">
</head>
Modified: sandbox/cloneable/libs/cloneable/doc/html/index.html
==============================================================================
--- sandbox/cloneable/libs/cloneable/doc/html/index.html (original)
+++ sandbox/cloneable/libs/cloneable/doc/html/index.html 2009-07-03 07:35:22 EDT (Fri, 03 Jul 2009)
@@ -28,7 +28,7 @@
</h3></div></div></div>
<div><p class="copyright">Copyright © 2009 Christian Schladetsch</p></div>
<div><div class="legalnotice" title="Legal Notice">
-<a name="id666566"></a><p>
+<a name="id660013"></a><p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
</p>
@@ -41,7 +41,7 @@
<dl>
<dt><span class="section"> Introduction</span></dt>
<dt><span class="section"> Change Log</span></dt>
-<dt><span class="section"> Basic Usage</span></dt>
+<dt><span class="section"> Tutorial</span></dt>
<dd><dl>
<dt><span class="section"><a href="cloneable/tutorial/simple_hierarchical_cloning.html">Simple
Hierarchical Cloning</a></span></dt>
@@ -65,7 +65,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: July 02, 2009 at 11:21:34 GMT</small></p></td>
+<td align="left"><p><small>Last revised: July 03, 2009 at 11:34:16 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
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