NextCloud/dlib
1
0
Fork 0
mirror of https://github.com/davisking/dlib.git synced 2024-11-01 10:14:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Moved the TIME_THIS docs into a more appropriate place.

Browse Source
This commit is contained in:
Davis King 2012-01-21 15:37:04 -05:00
parent 0b9785555c
commit c20afac0de
3 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/docs/metaprogramming.xml
View File

@ -71,7 +71,6 @@
<item>DLIB_ASSERT_HAS_STANDARD_LAYOUT</item>
<item>ASSERT_ARE_NOT_SAME_TYPE</item>
<item>_dT</item>
<item>TIME_THIS</item>
<item>is_same_object</item>
<item>assign_zero_if_built_in_scalar_type</item>
<item>wrap_function</item>
@ -703,27 +702,6 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>TIME_THIS</name>
<file>dlib/time_this.h</file>
<spec_file>dlib/time_this.h</spec_file>
<description>
<p>
This is a macro function for timing blocks of code. Its form is <tt>TIME_THIS(whatever you want to time)</tt>
It's pretty straight forward. It just prints the time it took to std::cout.
</p>
<p>
There is another version of this function called TIME_THIS_TO which takes as a parameter an ostream
object to write its output to. Its form is <tt>TIME_THIS_TO(what you want to time, the output stream)</tt>;
</p>
</description>
</component>
<!-- ************************************************************************* -->
<component>

23
docs/docs/other.xml
View File

@ -61,6 +61,7 @@
<item>serialize</item>
<item>zero_extend_cast</item>
<item>make_mfp</item>
<item>TIME_THIS</item>
</section>
<section>
@ -1030,6 +1031,28 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>TIME_THIS</name>
<file>dlib/time_this.h</file>
<spec_file>dlib/time_this.h</spec_file>
<description>
<p>
This is a macro function for timing blocks of code. Its form is <tt>TIME_THIS(whatever you want to time)</tt>
It's pretty straight forward. It just prints the time it took to std::cout.
</p>
<p>
There is another version of this function called TIME_THIS_TO which takes as a parameter an ostream
object to write its output to. Its form is <tt>TIME_THIS_TO(what you want to time, the output stream)</tt>;
</p>
</description>
</component>
<!-- ************************************************************************* -->
</components>

4
docs/docs/term_index.xml
View File

@ -487,8 +487,8 @@
<term file="metaprogramming.html" name="DLIB_CASSERT"/>
<term file="metaprogramming.html" name="COMPILE_TIME_ASSERT"/>
<term file="metaprogramming.html" name="DLIB_ASSERT_HAS_STANDARD_LAYOUT"/>
<term file="metaprogramming.html" name="TIME_THIS"/>
<term link="metaprogramming.html#TIME_THIS" name="TIME_THIS_TO"/>
<term file="other.html" name="TIME_THIS"/>
<term link="other.html#TIME_THIS" name="TIME_THIS_TO"/>
<term file="metaprogramming.html" name="_dT"/>
<term file="metaprogramming.html" name="is_pointer_type"/>
<term file="metaprogramming.html" name="is_const_type"/>