Skip to content

D
dlib
Commit 567b807e authored by Davis King's avatar Davis King
Browse files
Options

Fixed a bunch of spelling errors. 

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402798
parent ad9b3ebf
Hide whitespace changes
Inline Side-by-side
Showing with 37 additions and 41 deletions
docs/docs/algorithms.xml
View file @ 567b807e
......@@ -44,7 +44,7 @@
</sub>
</item>
<item nolink="true">
<name>Quntum Computing</name>
<name>Quantum Computing</name>
<sub>
<item>quantum_register</item>
<item>gate</item>
......@@ -637,7 +637,7 @@
<file>dlib/bigint/bigint_kernel_2.h</file>
<description>
This implementation is basically the same as kernel_1 except it uses the
Fast Fourier Transform to perform multiplcations much faster.
Fast Fourier Transform to perform multiplications much faster.
</description>
<typedefs>
......@@ -756,7 +756,7 @@
<file>dlib/geometry.h</file>
<spec_file>dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This object represents a rectangular region inside a cartesian
This object represents a rectangular region inside a Cartesian
coordinate system. It allows you to easily represent and manipulate
rectangles.
</description>
......@@ -1089,7 +1089,7 @@
This object represents a container for another function
object and an instance of the <a href="#vector_normalizer">vector_normalizer</a> object.
It automatically noramlizes all inputs before passing them
It automatically normalizes all inputs before passing them
off to the contained function object.
</description>
<examples>
......@@ -1448,7 +1448,7 @@
<file>dlib/algs.h</file>
<spec_file link="true">dlib/algs.h</spec_file>
<description>
This function takes three paramaters and finds the median of the three. The median is swapped into
This function takes three parameters and finds the median of the three. The median is swapped into
the first parameter and the first parameter ends up in one of the other two, unless the first parameter was
the median to begin with of course.
</description>
......@@ -1704,7 +1704,7 @@
<description>
This function takes a <a href="#rectangle">rectangle</a> and a
<a href="#point">point</a> and returns the point in the given
rectangle that is nearst to the given point.
rectangle that is nearest to the given point.
</description>
</component>
......
docs/docs/compile.xml
View file @ 567b807e
......@@ -116,7 +116,7 @@
<p>
This is a pretty good compiler and it is free. But it can be a major pain to use.
To get it working you have to download the platform sdk along with the toolkit itself.
Both of these things are available from the microsoft web page for free.
Both of these things are available from the Microsoft web page for free.
</p>
<p>
Once you have the toolkit and platform sdk installed you should be ready to go.
......
docs/docs/compression.xml
View file @ 567b807e
......@@ -190,7 +190,7 @@
<name>compress_stream_kernel_3</name>
<file>dlib/compress_stream/compress_stream_kernel_3.h</file>
<description>
This implementation is done using the the <a href="#lzp_buffer">lzp_buffer</a> object and
This implementation is done using the <a href="#lzp_buffer">lzp_buffer</a> object and
<a href="other.html#crc32">crc32</a> object. It does not use any sort of entropy coding, instead
a byte aligned output method is used.
</description>
......@@ -289,7 +289,7 @@
semi-sorted order to speed up the calculation of the cumulative count. This implementation
also uses the <a href="other.html#memory_manager">memory_manager</a> component to create a
memory pool of linked list nodes. This implementation is especially useful for high order
contexts and/or very large and sparce alphabets.
contexts and/or very large and sparse alphabets.
</description>
......@@ -829,7 +829,7 @@
<file>dlib/lzp_buffer.h</file>
<spec_file>dlib/lzp_buffer/lzp_buffer_kernel_abstract.h</spec_file>
<description>
This object represents some varation on the LZP algorithm
This object represents some variation on the LZP algorithm
described by Charles Bloom in his paper "LZP: a new data
compression algorithm"
</description>
......
docs/docs/containers.xml
View file @ 567b807e
......@@ -698,7 +698,7 @@
<description>
This is an implementation of a very simple templated container object.
It contains between 0 and 31 objects where each object is listed
explicity in the tuple's template arguments.
explicitly in the tuple's template arguments.
<p>
Note that there is only one implementation of this object so there aren't any
......
docs/docs/index.xml
View file @ 567b807e
......@@ -166,7 +166,7 @@
<li>Many <a href="containers.html">container classes</a></li>
<li><a href="other.html#serialize">Serialization support</a></li>
<li>Many <a href="other.html#memory_manager">memory manager</a> objects that implement
differnt memory pooling strategies</li>
different memory pooling strategies</li>
</ul>
</li>
</ul>
......
docs/docs/intro.xml
View file @ 567b807e
......@@ -118,7 +118,7 @@
<br/><u>missing ensures</u>: This means that the effects of the function are unspecified. This is often used
for call backs where the client programmer implements the actual function.
<br/><u>missing throws</u>: This doesn't mean anything. A function without a throws block
might throw excepitons or it might not.
might throw exceptions or it might not.
<br/>
<br/>
......@@ -164,7 +164,7 @@
<br/><li/> <anchor>CONVENTION</anchor> <b> CONVENTION </b>
<ul>
This is a section of the formal comment which appears at the top of all classes which are
This is a section of the formal comment which appears at the top of classes which are
actual implementations (as opposed to specifications). This section of the comment contains
a list of invariants that tell you what the member variables are used for. It also relates
the state of the member variables to the class interface.
......@@ -312,8 +312,8 @@
<a href="containers.html#queue">here</a>.
</p>
<p>
None of the above applies to the API components (or any global functions or objects that don't list multiple implemenations
in their documenation). To use/create them you just need to include
None of the above applies to the API components (or any global functions or objects that don't list multiple implementations
in their documentation). To use/create them you just need to include
the appropriate headers. For example, to create a mutex object from the <a href="api.html#threads">
threads</a> component you would simply type <tt>dlib::mutex my_mutex;</tt>. There is no
need to specify which kernel implementation. The correct kernel implementation
......
docs/docs/metaprogramming.xml
View file @ 567b807e
......@@ -158,7 +158,7 @@
<file>dlib/enable_if.h</file>
<description>
This is a family of templates from the Boost C++ libraries that makes it somewhat easier to control
template specilization. For the details see <a href="enable_if.html">
template specialization. For the details see <a href="enable_if.html">
this page</a>. Note that the header <tt>dlib/enable_if.h</tt> brings
these templates into the dlib namespace.<br/>
</description>
......@@ -349,7 +349,7 @@
<spec_file>dlib/assert.h</spec_file>
<description>
<p>
This is a macro function for debuging. Its form is <tt>ASSERT_ARE_NOT_SAME_TYPE(type1, type2)</tt>.
This is a macro function for debugging. Its form is <tt>ASSERT_ARE_NOT_SAME_TYPE(type1, type2)</tt>.
If type1 and type2 are the same type then the compile will fail. This is sometimes useful
in validating template arguments.
</p>
......@@ -365,7 +365,7 @@
<spec_file>dlib/assert.h</spec_file>
<description>
<p>
This is a macro function for debuging. Its form is <tt>ASSERT_ARE_SAME_TYPE(type1, type2)</tt>.
This is a macro function for debugging. Its form is <tt>ASSERT_ARE_SAME_TYPE(type1, type2)</tt>.
If type1 and type2 are not the same type then the compile will fail. This is sometimes useful
in validating template arguments.
</p>
......@@ -381,7 +381,7 @@
<spec_file>dlib/assert.h</spec_file>
<description>
<p>
This is a macro function for debuging. Its form is <tt>COMPILE_TIME_ASSERT(condition that should
This is a macro function for debugging. Its form is <tt>COMPILE_TIME_ASSERT(condition that should
be true)</tt>. The condition must be a compile time constant and if it is false then the compile
will fail.
</p>
......@@ -397,13 +397,13 @@
<spec_file>dlib/assert.h</spec_file>
<description>
<p>
This is a macro function that is identicial to the <a href="#DLIB_ASSERT">DLIB_ASSERT</a> macro
This is a macro function that is identical to the <a href="#DLIB_ASSERT">DLIB_ASSERT</a> macro
except that it is always enabled. Even if _DEBUG, DEBUG and ENABLE_ASSERTS are not defined.
</p>
<p>
Note that when this macro fails and throws an exception it also calls the global
C function dlib_assert_breakpoint(). This behavior makes it easy to set a debugging
tool to break when DLIB_CASSERT fails by setting a breakpoing on dlib_assert_breakpoint().
tool to break when DLIB_CASSERT fails by setting a breakpoint on dlib_assert_breakpoint().
</p>
</description>
......@@ -418,7 +418,7 @@
<spec_file>dlib/assert.h</spec_file>
<description>
<p>
This is a macro function for debuging. Its form is <tt>DLIB_ASSERT(condition that should be
This is a macro function for debugging. Its form is <tt>DLIB_ASSERT(condition that should be
true,error message)</tt>. If the condition is false DLIB_ASSERT throws an exception of type
dlib::fatal_error with fatal_error::type == EBROKEN_ASSERT. An error message detailing
the nature of the problem is stored in the member variable info which is of type std::string.
......@@ -432,7 +432,7 @@
<p>
Note that when this macro fails and throws an exception it also calls the global
C function dlib_assert_breakpoint(). This behavior makes it easy to set a debugging
tool to break when DLIB_CASSERT fails by setting a breakpoing on dlib_assert_breakpoint().
tool to break when DLIB_CASSERT fails by setting a breakpoint on dlib_assert_breakpoint().
</p>
</description>
......
docs/docs/other.xml
View file @ 567b807e
......@@ -163,7 +163,7 @@
<file>dlib/algs.h</file>
<spec_file link="true">dlib/algs.h</spec_file>
<description>
This is a templated function object that makes coppies of something.
This is a templated function object that makes copies of something.
</description>
</component>
......@@ -368,7 +368,7 @@
<extension>
<name>bit_stream_multi</name>
<spec_file>dlib/bit_stream/bit_stream_multi_abstract.h</spec_file>
<description>This extension gives a bit_stream object the ability to read/write multible bits at a time.</description>
<description>This extension gives a bit_stream object the ability to read/write multiple bits at a time.</description>
<implementations>
<implementation>
<name>bit_stream_multi_1</name>
......@@ -429,7 +429,7 @@
<description>
This object represents some kind of stateless memory manager or memory pool.
Stateless means that all instances (instances of the same type that is)
of this object are identical and can be used interchangably. Note that
of this object are identical and can be used interchangeably. Note that
implementations are allowed to have some shared global state such as a
global memory pool. This object is also thread safe.
</description>
......@@ -623,7 +623,7 @@
<file>dlib/memory_manager/memory_manager_kernel_2.h</file>
<description>
This memory manager implementation allocates memory in blocks of chunk_size*sizeof(T)
bytes. All the sizeof(T) subblocks are kept in a linked list of free memory blocks
bytes. All the sizeof(T) sub-blocks are kept in a linked list of free memory blocks
and are given out whenever an allocation request occurs. Also, memory is not freed
until this object is destructed.
Also note that array allocations are not managed at all but are passed directly
......@@ -660,7 +660,7 @@
<file>dlib/memory_manager/memory_manager_kernel_3.h</file>
<description>
This memory manager implementation allocates memory in blocks of chunk_size*sizeof(T)
bytes. All the sizeof(T) subblocks are kept in a linked list of free memory blocks
bytes. All the sizeof(T) sub-blocks are kept in a linked list of free memory blocks
and are given out whenever an allocation request occurs. Note that array allocations
are managed. So this object is just like kernel_2 but it also pools memory from
array allocations (chunk_size has no effect with respect to array allocations, each array
......@@ -801,7 +801,7 @@
<name>timer_kernel_2</name>
<file>dlib/timer/timer_kernel_2.h</file>
<description>
This implemenation has a single master thread that does all the waiting.
This implementation has a single master thread that does all the waiting.
This master thread creates and dispatches threads to specific timer objects
when they need to run their action functions. When a timer object isn't executing
its action function then it doesn't have any thread allocated to it at all. So
......@@ -862,7 +862,7 @@
<a href="dlib/test/CMakeLists.txt.html">dlib/test/CMakeLists.txt</a> to build it.
</p>
<p>
What you may find more useful however is the testing framework itself. It uses a faily simple
What you may find more useful however is the testing framework itself. It uses a fairly simple
and modular design. Each test is contained in its own cpp file and when compiled into the
program it automatically shows up in the list of tests to run. If you want to use the
testing framework all you need to do is add the files <a href="dlib/test/tester.h.html">dlib/test/tester.h</a>,
......
docs/docs/parsing.xml
View file @ 567b807e
......@@ -124,7 +124,7 @@
<file>dlib/string.h</file>
<spec_file link="true">dlib/string/string_abstract.h</spec_file>
<description>
This is a function to pad whitespace (or user specfied characters) onto the right most end of a string.
This is a function to pad whitespace (or user specified characters) onto the right most end of a string.
</description>
</component>
......@@ -136,7 +136,7 @@
<file>dlib/string.h</file>
<spec_file link="true">dlib/string/string_abstract.h</spec_file>
<description>
This is a function to pad whitespace (or user specfied characters) onto the left most end of a string.
This is a function to pad whitespace (or user specified characters) onto the left most end of a string.
</description>
</component>
......@@ -148,7 +148,7 @@
<file>dlib/string.h</file>
<spec_file link="true">dlib/string/string_abstract.h</spec_file>
<description>
This is a function to pad whitespace (or user specfied characters) onto the ends of a string.
This is a function to pad whitespace (or user specified characters) onto the ends of a string.
</description>
</component>
......@@ -160,7 +160,7 @@
<file>dlib/string.h</file>
<spec_file link="true">dlib/string/string_abstract.h</spec_file>
<description>
This is a function to remove the whitespace (or user specfied characters) from the right most end of a string.
This is a function to remove the whitespace (or user specified characters) from the right most end of a string.
</description>
</component>
......@@ -172,7 +172,7 @@
<file>dlib/string.h</file>
<spec_file link="true">dlib/string/string_abstract.h</spec_file>
<description>
This is a function to remove the whitespace (or user specfied characters) from the left most end of a string.
This is a function to remove the whitespace (or user specified characters) from the left most end of a string.
</description>
</component>
......@@ -184,7 +184,7 @@
<file>dlib/string.h</file>
<spec_file link="true">dlib/string/string_abstract.h</spec_file>
<description>
This is a function to remove the whitespace (or user specfied characters) from the ends of a string.
This is a function to remove the whitespace (or user specified characters) from the ends of a string.
</description>
</component>
......
docs/todo.txt
View file @ 567b807e
......@@ -32,10 +32,6 @@ add row_cat and col_cat matrix functions
make a multiline text field
make htmlify work right on tempalte function calls
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment