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

updated docs

Browse Source
This commit is contained in:
Davis King 2012-11-18 16:36:34 -05:00
parent 4807ab060f
commit bdd3e221f0
2 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/docs/other.xml
View File

@ -34,6 +34,7 @@
<item>timer</item>
<item>timeout</item>
<item>member_function_pointer</item>
<item>vectorstream</item>
<item>bound_function_pointer</item>
<item>error</item>
<item>console_progress_indicator</item>
@ -362,6 +363,30 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>vectorstream</name>
<file>dlib/vectorstream.h</file>
<spec_file>dlib/vectorstream/vectorstream_abstract.h</spec_file>
<description>
This is an iostream object that reads and writes from an in-memory buffer.
It functions very much the same way as the std::stringstream object.
However, while the std::stringstream holds its buffer internally and it can
only be accessed by copying it out, the vectorstream uses an external
std::vector&lt;char&gt; as its buffer. That is, it holds a reference to an
external vector and does not contain any internal buffers of its own.
<p>
This object is useful as a slightly more efficient alternative to the
std::stringstream since you can avoid the overhead of copying buffer
contents to and from the stream. This is particularly useful when used as
a source or target for <a href="#serialize">serialization</a> routines.
</p>
</description>
</component>
<!-- ************************************************************************* -->
<component>

1
docs/docs/term_index.xml
View File

@ -1224,6 +1224,7 @@
<term link="other.html#dlib_testing_suite" name="testing"/>
<term link="other.html#dlib_testing_suite" name="unit testing"/>
<term file="other.html" name="logger"/>
<term file="other.html" name="vectorstream"/>
<term file="other.html" name="member_function_pointer"/>
<term file="other.html" name="make_mfp"/>
<term file="other.html" name="bound_function_pointer"/>