[Boost-commit] svn:boost r45729 - sandbox/SOC/2007/visualization/libs/svg_plot/doc

From: pbristow_at_[hidden]
Date: 2008-05-24 12:39:35

Author: pbristow
Date: 2008-05-24 12:39:35 EDT (Sat, 24 May 2008)
New Revision: 45729
URL: http://svn.boost.org/trac/boost/changeset/45729

Log:
New docs to fit with docs Quickbook in code
Added:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/1d_autoscale_containers.qbk   (contents, props changed)

Added: sandbox/SOC/2007/visualization/libs/svg_plot/doc/1d_autoscale_containers.qbk
==============================================================================
--- (empty file)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/1d_autoscale_containers.qbk	2008-05-24 12:39:35 EDT (Sat, 24 May 2008)
@@ -0,0 +1,22 @@
+[section:1d_autoscale_containers Tutorial: 1D Autoscale with Multiple Containers]
+
+This example demonstrates autoscaling with *multiple* STL containers.
+
+[import ../example/auto_1d_containers.cpp]
+
+[auto_1d_containers_1]
+[auto_1d_containers_2]
+
+[warning The containers must be of the same type to use the function range_all.
+If different types of containers, for example some in a set and some in a vector,
+then the min and max for each container must be computed separately
+and the minimum of the minimums and the maximum of the maximums injected into the 
+x_autoscale (or y_autoscale) call.]
+
+Typical output is:
+[auto_1d_containers_output]
+
+See [@../../example/auto_1d_containers.cpp auto_1d_containers.cpp]
+for full source code and sample output.
+
+[endsect] [/ section:1d_autoscale_containers Tutorial: 1D Autoscale with Multiple Containers]