Commit 526220a1 authored by Fangjun KUANG's avatar Fangjun KUANG Committed by Vadim Pisarevsky

Fix typos in the documentation (#8226)

* fix typos.

* Fix typos.

* Fix typos.

* Fix typos.

* Fix typos.
parent 5bfaf993
...@@ -114,7 +114,7 @@ public: ...@@ -114,7 +114,7 @@ public:
*/ */
Exception(); Exception();
/*! /*!
Full constructor. Normally the constuctor is not called explicitly. Full constructor. Normally the constructor is not called explicitly.
Instead, the macros CV_Error(), CV_Error_() and CV_Assert() are used. Instead, the macros CV_Error(), CV_Error_() and CV_Assert() are used.
*/ */
Exception(int _code, const String& _err, const String& _func, const String& _file, int _line); Exception(int _code, const String& _err, const String& _func, const String& _file, int _line);
...@@ -131,8 +131,8 @@ public: ...@@ -131,8 +131,8 @@ public:
int code; ///< error code @see CVStatus int code; ///< error code @see CVStatus
String err; ///< error description String err; ///< error description
String func; ///< function name. Available only when the compiler supports getting it String func; ///< function name. Available only when the compiler supports getting it
String file; ///< source file name where the error has occured String file; ///< source file name where the error has occurred
int line; ///< line number in the source file where the error has occured int line; ///< line number in the source file where the error has occurred
}; };
/*! @brief Signals an error and raises the exception. /*! @brief Signals an error and raises the exception.
......
...@@ -2654,7 +2654,7 @@ CVAPI(int) cvGetErrMode( void ); ...@@ -2654,7 +2654,7 @@ CVAPI(int) cvGetErrMode( void );
/** Sets error processing mode, returns previously used mode */ /** Sets error processing mode, returns previously used mode */
CVAPI(int) cvSetErrMode( int mode ); CVAPI(int) cvSetErrMode( int mode );
/** Sets error status and performs some additonal actions (displaying message box, /** Sets error status and performs some additional actions (displaying message box,
writing message to stderr, terminating application etc.) writing message to stderr, terminating application etc.)
depending on the current error mode */ depending on the current error mode */
CVAPI(void) cvError( int status, const char* func_name, CVAPI(void) cvError( int status, const char* func_name,
...@@ -2663,7 +2663,7 @@ CVAPI(void) cvError( int status, const char* func_name, ...@@ -2663,7 +2663,7 @@ CVAPI(void) cvError( int status, const char* func_name,
/** Retrieves textual description of the error given its code */ /** Retrieves textual description of the error given its code */
CVAPI(const char*) cvErrorStr( int status ); CVAPI(const char*) cvErrorStr( int status );
/** Retrieves detailed information about the last error occured */ /** Retrieves detailed information about the last error occurred */
CVAPI(int) cvGetErrInfo( const char** errcode_desc, const char** description, CVAPI(int) cvGetErrInfo( const char** errcode_desc, const char** description,
const char** filename, int* line ); const char** filename, int* line );
......
...@@ -416,7 +416,7 @@ Cv64suf; ...@@ -416,7 +416,7 @@ Cv64suf;
#define CV_IS_SUBMAT(flags) ((flags) & CV_MAT_SUBMAT_FLAG) #define CV_IS_SUBMAT(flags) ((flags) & CV_MAT_SUBMAT_FLAG)
/** Size of each channel item, /** Size of each channel item,
0x124489 = 1000 0100 0100 0010 0010 0001 0001 ~ array of sizeof(arr_type_elem) */ 0x8442211 = 1000 0100 0100 0010 0010 0001 0001 ~ array of sizeof(arr_type_elem) */
#define CV_ELEM_SIZE1(type) \ #define CV_ELEM_SIZE1(type) \
((((sizeof(size_t)<<28)|0x8442211) >> CV_MAT_DEPTH(type)*4) & 15) ((((sizeof(size_t)<<28)|0x8442211) >> CV_MAT_DEPTH(type)*4) & 15)
......
...@@ -61,8 +61,8 @@ namespace cv ...@@ -61,8 +61,8 @@ namespace cv
#ifdef CV_COLLECT_IMPL_DATA #ifdef CV_COLLECT_IMPL_DATA
CV_EXPORTS void setImpl(int flags); // set implementation flags and reset storage arrays CV_EXPORTS void setImpl(int flags); // set implementation flags and reset storage arrays
CV_EXPORTS void addImpl(int flag, const char* func = 0); // add implementation and function name to storage arrays CV_EXPORTS void addImpl(int flag, const char* func = 0); // add implementation and function name to storage arrays
// Get stored implementation flags and fucntions names arrays // Get stored implementation flags and functions names arrays
// Each implementation entry correspond to function name entry, so you can find which implementation was executed in which fucntion // Each implementation entry correspond to function name entry, so you can find which implementation was executed in which function
CV_EXPORTS int getImpl(std::vector<int> &impl, std::vector<String> &funName); CV_EXPORTS int getImpl(std::vector<int> &impl, std::vector<String> &funName);
CV_EXPORTS bool useCollection(); // return implementation collection state CV_EXPORTS bool useCollection(); // return implementation collection state
...@@ -196,7 +196,7 @@ be called outside of parallel region. ...@@ -196,7 +196,7 @@ be called outside of parallel region.
OpenCV will try to run it's functions with specified threads number, but some behaviour differs from OpenCV will try to run it's functions with specified threads number, but some behaviour differs from
framework: framework:
- `TBB` – User-defined parallel constructions will run with the same threads number, if - `TBB` – User-defined parallel constructions will run with the same threads number, if
another does not specified. If late on user creates own scheduler, OpenCV will be use it. another does not specified. If later on user creates own scheduler, OpenCV will use it.
- `OpenMP` – No special defined behaviour. - `OpenMP` – No special defined behaviour.
- `Concurrency` – If threads == 1, OpenCV will disable threading optimizations and run it's - `Concurrency` – If threads == 1, OpenCV will disable threading optimizations and run it's
functions sequentially. functions sequentially.
...@@ -229,7 +229,7 @@ CV_EXPORTS_W int getNumThreads(); ...@@ -229,7 +229,7 @@ CV_EXPORTS_W int getNumThreads();
returns 0 if called outside of parallel region. returns 0 if called outside of parallel region.
The exact meaning of return value depends on the threading framework used by OpenCV library: The exact meaning of return value depends on the threading framework used by OpenCV library:
- `TBB` – Unsupported with current 4.1 TBB release. May be will be supported in future. - `TBB` – Unsupported with current 4.1 TBB release. Maybe will be supported in future.
- `OpenMP` – The thread number, within the current team, of the calling thread. - `OpenMP` – The thread number, within the current team, of the calling thread.
- `Concurrency` – An ID for the virtual processor that the current context is executing on (0 - `Concurrency` – An ID for the virtual processor that the current context is executing on (0
for master thread and unique number for others, but not necessary 1,2,3,...). for master thread and unique number for others, but not necessary 1,2,3,...).
...@@ -636,7 +636,7 @@ class TLSData : protected TLSDataContainer ...@@ -636,7 +636,7 @@ class TLSData : protected TLSDataContainer
public: public:
inline TLSData() {} inline TLSData() {}
inline ~TLSData() { release(); } // Release key and delete associated data inline ~TLSData() { release(); } // Release key and delete associated data
inline T* get() const { return (T*)getData(); } // Get data assosiated with key inline T* get() const { return (T*)getData(); } // Get data associated with key
// Get data from all threads // Get data from all threads
inline void gather(std::vector<T*> &data) const inline void gather(std::vector<T*> &data) const
...@@ -687,7 +687,7 @@ The sample below demonstrates how to use CommandLineParser: ...@@ -687,7 +687,7 @@ The sample below demonstrates how to use CommandLineParser:
### Keys syntax ### Keys syntax
The keys parameter is a string containing several blocks, each one is enclosed in curley braces and The keys parameter is a string containing several blocks, each one is enclosed in curly braces and
describes one argument. Each argument contains three parts separated by the `|` symbol: describes one argument. Each argument contains three parts separated by the `|` symbol:
-# argument names is a space-separated list of option synonyms (to mark argument as positional, prefix it with the `@` symbol) -# argument names is a space-separated list of option synonyms (to mark argument as positional, prefix it with the `@` symbol)
...@@ -845,7 +845,7 @@ public: ...@@ -845,7 +845,7 @@ public:
/** @brief Check for parsing errors /** @brief Check for parsing errors
Returns true if error occured while accessing the parameters (bad conversion, missing arguments, Returns true if error occurred while accessing the parameters (bad conversion, missing arguments,
etc.). Call @ref printErrors to print error messages list. etc.). Call @ref printErrors to print error messages list.
*/ */
bool check() const; bool check() const;
......
...@@ -751,7 +751,7 @@ CV_IMPL const char* cvErrorStr( int status ) ...@@ -751,7 +751,7 @@ CV_IMPL const char* cvErrorStr( int status )
case CV_StsAutoTrace : return "Autotrace call"; case CV_StsAutoTrace : return "Autotrace call";
case CV_StsBadSize : return "Incorrect size of input array"; case CV_StsBadSize : return "Incorrect size of input array";
case CV_StsNullPtr : return "Null pointer"; case CV_StsNullPtr : return "Null pointer";
case CV_StsDivByZero : return "Division by zero occured"; case CV_StsDivByZero : return "Division by zero occurred";
case CV_BadStep : return "Image step is wrong"; case CV_BadStep : return "Image step is wrong";
case CV_StsInplaceNotSupported : return "Inplace operation is not supported"; case CV_StsInplaceNotSupported : return "Inplace operation is not supported";
case CV_StsObjectNotFound : return "Requested object was not found"; case CV_StsObjectNotFound : return "Requested object was not found";
...@@ -1035,7 +1035,7 @@ public: ...@@ -1035,7 +1035,7 @@ public:
{ {
if(threads[i]) if(threads[i])
{ {
/* Current architecture doesn't allow proper global objects relase, so this check can cause crashes /* Current architecture doesn't allow proper global objects release, so this check can cause crashes
// Check if all slots were properly cleared // Check if all slots were properly cleared
for(size_t j = 0; j < threads[i]->slots.size(); j++) for(size_t j = 0; j < threads[i]->slots.size(); j++)
...@@ -1085,7 +1085,7 @@ public: ...@@ -1085,7 +1085,7 @@ public:
return (tlsSlots.size()-1); return (tlsSlots.size()-1);
} }
// Release TLS storage index and pass assosiated data to caller // Release TLS storage index and pass associated data to caller
void releaseSlot(size_t slotIdx, std::vector<void*> &dataVec) void releaseSlot(size_t slotIdx, std::vector<void*> &dataVec)
{ {
AutoLock guard(mtxGlobalAccess); AutoLock guard(mtxGlobalAccess);
...@@ -1196,7 +1196,7 @@ void TLSDataContainer::release() ...@@ -1196,7 +1196,7 @@ void TLSDataContainer::release()
std::vector<void*> data; std::vector<void*> data;
data.reserve(32); data.reserve(32);
getTlsStorage().releaseSlot(key_, data); // Release key and get stored data for proper destruction getTlsStorage().releaseSlot(key_, data); // Release key and get stored data for proper destruction
for(size_t i = 0; i < data.size(); i++) // Delete all assosiated data for(size_t i = 0; i < data.size(); i++) // Delete all associated data
deleteDataInstance(data[i]); deleteDataInstance(data[i]);
key_ = -1; key_ = -1;
} }
......
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