Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63464 - in sandbox/chrono/libs/chrono/doc: . html html/boost_chrono/appendices html/boost_chrono/reference
From: vicente.botet_at_[hidden]
Date: 2010-06-30 19:50:51

Author: viboes
Date: 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
New Revision: 63464
URL: http://svn.boost.org/trac/boost/changeset/63464

Log:
Update doc
Text files modified:
   sandbox/chrono/libs/chrono/doc/chrono.qbk | 32 ++++++++++++++++++++------------
   sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/faq.html | 12 ++++++------
   sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/perf.html | 4 ++--
   sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/rationale.html | 8 ++++----
   sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/todo.html | 4 ++--
   sandbox/chrono/libs/chrono/doc/html/boost_chrono/reference/reporters.html | 40 +++++++++++++++++++++++++---------------
   sandbox/chrono/libs/chrono/doc/html/index.html | 2 +-
   7 files changed, 60 insertions(+), 42 deletions(-)

Modified: sandbox/chrono/libs/chrono/doc/chrono.qbk
==============================================================================
--- sandbox/chrono/libs/chrono/doc/chrono.qbk (original)
+++ sandbox/chrono/libs/chrono/doc/chrono.qbk 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -4443,15 +4443,20 @@
[/==================================================]

 namespace boost { namespace chrono {
- template <class Stopwatch>
- struct basic_stopwatch_reporter_default_formatter;
+ template <class Stopwatch, class Formatter>
+ class basic_stopwatch_reporter;
+
 template <class Stopwatch>
 struct stopwatch_reporter_default_formatter;
- template <class Stopwatch>
- struct wstopwatch_reporter_default_formatter;

 template <class Stopwatch, class Formatter=typename stopwatch_reporter_default_formatter<Stopwatch>::type>
 class stopwatch_reporter;
+
+ template <class Stopwatch>
+ struct wstopwatch_reporter_default_formatter;
+
+ template <class Stopwatch, class Formatter=typename wstopwatch_reporter_default_formatter<Stopwatch>::type>
+ class wstopwatch_reporter;
 }}

[section:basic_stopwatch_reporter Template Class `basic_stopwatch_reporter<>`]
@@ -4683,7 +4688,7 @@

[section:basic_stopclock Template Class `basic_stopclock<>`]

-`basic_stopclock<Clock>` template class is a shortcut of `basic_stopwatch_reporter<stopwatch<Clock>>`
+`basic_stopclock<Clock,Formatter>` template class is a shortcut of `basic_stopwatch_reporter<stopwatch<Clock,Formatter>>`

 template< class Clock, class Formatter>
 class basic_stopclock : public basic_stopwatch_reporter<stopwatch<Clock>, Formatter> {
@@ -4727,7 +4732,7 @@

[section:stopclock Template Class `stopclock<>`]

-`stopclock<Clock>` template class is a shortcut of `stopwatch_reporter<stopwatch<Clock>>` with a specific default formatter.
+`stopclock<Clock>` template class is a shortcut of `basic_stopclock<Clock, typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type>` with a specific default formatter.

 template
 < class Clock=process_cpu_clock
@@ -4785,7 +4790,7 @@

[section:wstopclock Template Class `wstopclock<>`]

-`wstopclock<Clock>` template class is a shortcut of `stopwatch_reporter<stopwatch<Clock>>` with a specific default formatter.
+`wstopclock<Clock>` template class is a shortcut of `basic_wstopclock<Clock, typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type>` with a specific default formatter.

 template
 < class Clock=process_cpu_clock
@@ -4877,7 +4882,7 @@

[section:basic_stopclock_accumulator Template Class `basic_stopclock_accumulator<>`]

-`basic_stopclock_accumulator<Clock>` template class is a shortcut of `stopwatch_reporter<stopwatch<Clock>>`
+`basic_stopclock_accumulator<Clock>` template class is a shortcut of `basic_stopwatch_reporter<stopwatch_accumulator<Clock>, typename stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock>>::type>`

 template
 < class Clock=high_resolution_clock
@@ -4970,9 +4975,9 @@
[endsect]
[section:stopclock_accumulator_typedefs `stopclock_accumulator` useful typedefs]

- typedef boost::chrono::stopclock_accumulator< boost::chrono::system_clock > system_stopwatch_reporter;
+ typedef boost::chrono::stopclock_accumulator< boost::chrono::system_clock > system_stopclock_accumulator;
 #ifdef BOOST_CHRONO_HAS_CLOCK_MONOTONIC
- typedef boost::chrono::stopclock_accumulator< boost::chrono::monotonic_clock > monotonic_stopwatch_reporter;
+ typedef boost::chrono::stopclock_accumulator< boost::chrono::monotonic_clock > monotonic_stopclock_accumulator;
 #endif
 typedef boost::chrono::stopclock_accumulator< boost::chrono::high_resolution_clock > high_resolution_stopclock_accumulator;
 typedef boost::chrono::stopclock_accumulator< boost::chrono::process_real_cpu_clock > process_real_cpu_stopclock_accumulator;
@@ -5028,9 +5033,9 @@
[endsect]
[section:wstopclock_accumulator_typedefs `wstopclock_accumulator` useful typedefs]

- typedef boost::chrono::wstopclock_accumulator< boost::chrono::system_clock > system_stopwatch_reporter;
+ typedef boost::chrono::wstopclock_accumulator< boost::chrono::system_clock > system_wstopclock_accumulator;
 #ifdef BOOST_CHRONO_HAS_CLOCK_MONOTONIC
- typedef boost::chrono::wstopclock_accumulator< boost::chrono::monotonic_clock > monotonic_stopwatch_reporter;
+ typedef boost::chrono::wstopclock_accumulator< boost::chrono::monotonic_clock > monotonic_wstopclock_accumulator;
 #endif
 typedef boost::chrono::wstopclock_accumulator< boost::chrono::high_resolution_clock > high_resolution_wstopclock_accumulator;
 typedef boost::chrono::wstopclock_accumulator< boost::chrono::process_real_cpu_clock > process_real_cpu_wstopclock_accumulator;
@@ -5070,6 +5075,9 @@
 return 0;
 }

+
+[heading Synopsis]
+
 template < class Clock=process_cpu_clock
 , class Formatter=typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type
> class scoped_stopclock

Modified: sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/faq.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/faq.html (original)
+++ sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/faq.html 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -29,7 +29,7 @@
<a name="boost_chrono.appendices.faq"></a> Appendix D: FAQ
</h3></div></div></div>
<a name="boost_chrono.appendices.faq.how_important_is_the_order_of_the_common_type_lt__gt__template_arguments_"></a><h4>
-<a name="id4938147"></a>
+<a name="id4938420"></a>
 <a href="faq.html#boost_chrono.appendices.faq.how_important_is_the_order_of_the_common_type_lt__gt__template_arguments_">How
 important is the order of the common_type<> template arguments?</a>
 </h4>
@@ -60,7 +60,7 @@
 is also undefined.
 
<a name="boost_chrono.appendices.faq.why_does_stopwatch_reporter_only_display_millisecond_place_precision_when_the_underlying_clock_has_nanosecond_precision_"></a><h4>
-<a name="id4938558"></a>
+<a name="id4938830"></a>
 <a href="faq.html#boost_chrono.appendices.faq.why_does_stopwatch_reporter_only_display_millisecond_place_precision_when_the_underlying_clock_has_nanosecond_precision_">Why
 does stopwatch_reporter only display millisecond place precision when the
 underlying Clock has nanosecond precision?</a>
@@ -71,7 +71,7 @@
 dangerously.
 
<a name="boost_chrono.appendices.faq.why_does_stopwatch_reporter_sometimes_report_more_cpu_seconds_than_real_seconds_"></a><h4>
-<a name="id4938599"></a>
+<a name="id4938872"></a>
 <a href="faq.html#boost_chrono.appendices.faq.why_does_stopwatch_reporter_sometimes_report_more_cpu_seconds_than_real_seconds_">Why
 does stopwatch_reporter sometimes report more cpu seconds than real seconds?</a>
 </h4>
@@ -81,7 +81,7 @@
 be reporting at times.
 
<a name="boost_chrono.appendices.faq.can_i_obtain_statistics_of_the_time_elapsed_between_calls_to_a_function_"></a><h4>
-<a name="id4938633"></a>
+<a name="id4938905"></a>
 <a href="faq.html#boost_chrono.appendices.faq.can_i_obtain_statistics_of_the_time_elapsed_between_calls_to_a_function_">Can
 I obtain statistics of the time elapsed between calls to a function?</a>
 </h4>
@@ -89,13 +89,13 @@
 The library do not provides this feature.
 
<a name="boost_chrono.appendices.faq.what_happens_if_i_press_ctrl_c_and_program_terminates__what_log_would_boost_chrono_output_"></a><h4>
-<a name="id4938661"></a>
+<a name="id4938934"></a>
 <a href="faq.html#boost_chrono.appendices.faq.what_happens_if_i_press_ctrl_c_and_program_terminates__what_log_would_boost_chrono_output_">What
 happens if I press Ctrl+C and program terminates? What log would Boost.chrono
 output?</a>
 </h4>
<a name="boost_chrono.appendices.faq.can_you_explain_the_pros_cons_of_common_type_against_boost_typeof_"></a><h4>
-<a name="id4938690"></a>
+<a name="id4938963"></a>
 <a href="faq.html#boost_chrono.appendices.faq.can_you_explain_the_pros_cons_of_common_type_against_boost_typeof_">Can
 you explain the pros/cons of common_type against Boost.Typeof?</a>
 </h4>

Modified: sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/perf.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/perf.html (original)
+++ sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/perf.html 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -69,7 +69,7 @@
 with a variable lifetime.
 
<a name="boost_chrono.appendices.perf.single_threaded_recursive_function"></a><h4>
-<a name="id4942333"></a>
+<a name="id4942600"></a>
 <a href="perf.html#boost_chrono.appendices.perf.single_threaded_recursive_function">Single-Threaded
 Recursive function</a>
 </h4>
@@ -92,7 +92,7 @@
 and thread_clock.
 
<a name="boost_chrono.appendices.perf.multi_threaded_recursive_function"></a><h4>
-<a name="id4942383"></a>
+<a name="id4942650"></a>
 <a href="perf.html#boost_chrono.appendices.perf.multi_threaded_recursive_function">Multi-Threaded
 Recursive function</a>
 </h4>

Modified: sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/rationale.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/rationale.html (original)
+++ sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/rationale.html 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -33,7 +33,7 @@
 are an extract from this document.
 
<a name="boost_chrono.appendices.rationale.is_it_possible_for_the_user_to_pass_a___link_linkend__boost_chrono_reference_cpp0x_chrono_chrono_hpp_duration___code__phrase_role__identifier__duration__phrase___code___link__to_a_function_with_the_units_being_ambiguous_"></a><h4>
-<a name="id4936922"></a>
+<a name="id4937195"></a>
 <a href="rationale.html#boost_chrono.appendices.rationale.is_it_possible_for_the_user_to_pass_a___link_linkend__boost_chrono_reference_cpp0x_chrono_chrono_hpp_duration___code__phrase_role__identifier__duration__phrase___code___link__to_a_function_with_the_units_being_ambiguous_">Is
 it possible for the user to pass a <a href="../reference/cpp0x.html#boost_chrono.reference.cpp0x.chrono_chrono_hpp.duration" title="
 Class template duration<>"><code class="computeroutput">duration</code></a> to a function with the
@@ -46,7 +46,7 @@
<pre class="programlisting">f(3); // Will not compile, 3 is not implicitly convertible to any __duration__
</pre>
<a name="boost_chrono.appendices.rationale.why_duration_needs_operator_"></a><h4>
-<a name="id4937021"></a>
+<a name="id4937294"></a>
 <a href="rationale.html#boost_chrono.appendices.rationale.why_duration_needs_operator_">Why
 duration needs operator%</a>
 </h4>
@@ -74,7 +74,7 @@
};
</pre>
<a name="boost_chrono.appendices.rationale.why_ratio_needs_copyconstruction_and_assignment_from_ratios_having_the_same_normalized_form"></a><h4>
-<a name="id4937601"></a>
+<a name="id4937874"></a>
 <a href="rationale.html#boost_chrono.appendices.rationale.why_ratio_needs_copyconstruction_and_assignment_from_ratios_having_the_same_normalized_form">Why
 ratio needs CopyConstruction and Assignment from ratios having the same normalized
 form</a>
@@ -102,7 +102,7 @@
 ratio<1,3> and the compilation succeeds.
 
<a name="boost_chrono.appendices.rationale.why_ratio_needs_the_nested_normalizer_typedef_type"></a><h4>
-<a name="id4937914"></a>
+<a name="id4938187"></a>
 <a href="rationale.html#boost_chrono.appendices.rationale.why_ratio_needs_the_nested_normalizer_typedef_type">Why
 ratio needs the nested normalizer typedef type</a>
 </h4>

Modified: sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/todo.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/todo.html (original)
+++ sandbox/chrono/libs/chrono/doc/html/boost_chrono/appendices/todo.html 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -26,7 +26,7 @@
<a name="boost_chrono.appendices.todo"></a> Appendix I: Future plans
</h3></div></div></div>
<a name="boost_chrono.appendices.todo.tasks_to_do_before_review"></a><h4>
-<a name="id4942449"></a>
+<a name="id4942716"></a>
 <a href="todo.html#boost_chrono.appendices.todo.tasks_to_do_before_review">Tasks
 to do before review</a>
 </h4>
@@ -42,7 +42,7 @@
 </li>
</ul></div>
<a name="boost_chrono.appendices.todo.for_later_releases"></a><h4>
-<a name="id4942488"></a>
+<a name="id4942755"></a>
 <a href="todo.html#boost_chrono.appendices.todo.for_later_releases">For later
 releases</a>
 </h4>

Modified: sandbox/chrono/libs/chrono/doc/html/boost_chrono/reference/reporters.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/html/boost_chrono/reference/reporters.html (original)
+++ sandbox/chrono/libs/chrono/doc/html/boost_chrono/reference/reporters.html 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -236,15 +236,20 @@
 Template Class <code class="computeroutput">wstopwatch_reporter<></code></a></dt>
</dl></div>
<pre class="programlisting">namespace boost { namespace chrono {
- template <class Stopwatch>
- struct basic_stopwatch_reporter_default_formatter;
+ template <class Stopwatch, class Formatter>
+ class basic_stopwatch_reporter;
+
 template <class Stopwatch>
 struct stopwatch_reporter_default_formatter;
- template <class Stopwatch>
- struct wstopwatch_reporter_default_formatter;

 template <class Stopwatch, class Formatter=typename stopwatch_reporter_default_formatter<Stopwatch>::type>
 class stopwatch_reporter;
+
+ template <class Stopwatch>
+ struct wstopwatch_reporter_default_formatter;
+
+ template <class Stopwatch, class Formatter=typename wstopwatch_reporter_default_formatter<Stopwatch>::type>
+ class wstopwatch_reporter;
}}
</pre>
<div class="section" lang="en">
@@ -538,8 +543,8 @@
 Template Class <code class="computeroutput">basic_stopclock<></code></a>
</h5></div></div></div>

- <code class="computeroutput">basic_stopclock<Clock></code>
- template class is a shortcut of <code class="computeroutput">basic_stopwatch_reporter<stopwatch<Clock>></code>
+ <code class="computeroutput">basic_stopclock<Clock,Formatter></code>
+ template class is a shortcut of <code class="computeroutput">basic_stopwatch_reporter<stopwatch<Clock,Formatter>></code>
 
<pre class="programlisting">template< class Clock, class Formatter>
class basic_stopclock : public basic_stopwatch_reporter<stopwatch<Clock>, Formatter> {
@@ -588,7 +593,7 @@
</h5></div></div></div>

 <code class="computeroutput">stopclock<Clock></code>
- template class is a shortcut of <code class="computeroutput">stopwatch_reporter<stopwatch<Clock>></code> with a specific default formatter.
+ template class is a shortcut of <code class="computeroutput">basic_stopclock<Clock, typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type></code> with a specific default formatter.
 
<pre class="programlisting">template
 < class Clock=process_cpu_clock
@@ -655,7 +660,7 @@
</h5></div></div></div>

 <code class="computeroutput">wstopclock<Clock></code>
- template class is a shortcut of <code class="computeroutput">stopwatch_reporter<stopwatch<Clock>></code> with a specific default formatter.
+ template class is a shortcut of <code class="computeroutput">basic_wstopclock<Clock, typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type></code> with a specific default formatter.
 
<pre class="programlisting">template
 < class Clock=process_cpu_clock
@@ -770,7 +775,8 @@
</h5></div></div></div>

 <code class="computeroutput">basic_stopclock_accumulator<Clock></code> template class is a shortcut of
- <code class="computeroutput">stopwatch_reporter<stopwatch<Clock>></code>
+ <code class="computeroutput">basic_stopwatch_reporter<stopwatch_accumulator<Clock>, typename
+ stopwatch_reporter_default_formatter<stopwatch_accumulator<Clock>>::type></code>
 
<pre class="programlisting">template
 < class Clock=high_resolution_clock
@@ -875,9 +881,9 @@
 <code class="computeroutput">stopclock_accumulator</code> useful
 typedefs</a>
</h5></div></div></div>
-<pre class="programlisting">typedef boost::chrono::stopclock_accumulator< boost::chrono::system_clock > system_stopwatch_reporter;
+<pre class="programlisting">typedef boost::chrono::stopclock_accumulator< boost::chrono::system_clock > system_stopclock_accumulator;
#ifdef BOOST_CHRONO_HAS_CLOCK_MONOTONIC
-typedef boost::chrono::stopclock_accumulator< boost::chrono::monotonic_clock > monotonic_stopwatch_reporter;
+typedef boost::chrono::stopclock_accumulator< boost::chrono::monotonic_clock > monotonic_stopclock_accumulator;
#endif
typedef boost::chrono::stopclock_accumulator< boost::chrono::high_resolution_clock > high_resolution_stopclock_accumulator;
typedef boost::chrono::stopclock_accumulator< boost::chrono::process_real_cpu_clock > process_real_cpu_stopclock_accumulator;
@@ -946,9 +952,9 @@
 <code class="computeroutput">wstopclock_accumulator</code>
 useful typedefs</a>
</h5></div></div></div>
-<pre class="programlisting">typedef boost::chrono::wstopclock_accumulator< boost::chrono::system_clock > system_stopwatch_reporter;
+<pre class="programlisting">typedef boost::chrono::wstopclock_accumulator< boost::chrono::system_clock > system_wstopclock_accumulator;
#ifdef BOOST_CHRONO_HAS_CLOCK_MONOTONIC
-typedef boost::chrono::wstopclock_accumulator< boost::chrono::monotonic_clock > monotonic_stopwatch_reporter;
+typedef boost::chrono::wstopclock_accumulator< boost::chrono::monotonic_clock > monotonic_wstopclock_accumulator;
#endif
typedef boost::chrono::wstopclock_accumulator< boost::chrono::high_resolution_clock > high_resolution_wstopclock_accumulator;
typedef boost::chrono::wstopclock_accumulator< boost::chrono::process_real_cpu_clock > process_real_cpu_wstopclock_accumulator;
@@ -1000,8 +1006,12 @@

 return 0;
}
-
-template < class Clock=process_cpu_clock
+</pre>
+<a name="boost_chrono.reference.reporters.scoped_stopclock_hpp.scoped_stopclock.synopsis"></a><h6>
+<a name="id4924649"></a>
+ Synopsis
+ </h6>
+<pre class="programlisting">template < class Clock=process_cpu_clock
 , class Formatter=typename stopwatch_reporter_default_formatter<stopwatch<Clock>>::type
> class scoped_stopclock
 : public stopwatch_reporter<stopwatch<Clock>, Formatter> {

Modified: sandbox/chrono/libs/chrono/doc/html/index.html
==============================================================================
--- sandbox/chrono/libs/chrono/doc/html/index.html (original)
+++ sandbox/chrono/libs/chrono/doc/html/index.html 2010-06-30 19:50:49 EDT (Wed, 30 Jun 2010)
@@ -98,7 +98,7 @@
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: June 30, 2010 at 23:13:59 GMT</td>
+<td align="left">Last revised: June 30, 2010 at 23:48:14 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Date view	Thread view	Subject view	Author view

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