1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00

0031939: Coding - correction of spelling errors in comments [part 9]

Fix various typos via codespell.
This commit is contained in:
luz paz
2021-04-01 20:18:10 +03:00
committed by bugmaster
parent 00e9052bee
commit 5e6e59146f
59 changed files with 288 additions and 512 deletions

View File

@@ -23,36 +23,28 @@
#include <NCollection_DefineAlloc.hxx>
#include <NCollection_StlIterator.hxx>
// *********************************************** Template for Array1 class
/**
* Purpose: The class Array1 represents unidimensional arrays
* of fixed size known at run time.
* The range of the index is user defined.
* An array1 can be constructed with a "C array".
* This functionality is useful to call methods expecting
* an Array1. It allows to carry the bounds inside the arrays.
*
* Examples: Item tab[100]; // An example with a C array
* Array1OfItem ttab (tab[0],1,100);
*
* Array1OfItem tttab (ttab(10),10,20); // a slice of ttab
*
* If you want to reindex an array from 1 to Length do :
*
* Array1 tab1(tab(tab.Lower()),1,tab.Length());
*
* Warning: Programs client of such a class must be independant
* of the range of the first element. Then, a C++ for
* loop must be written like this
*
* for (i = A.Lower(); i <= A.Upper(); i++)
*
* Changes: In comparison to TCollection the flag isAllocated was
* renamed into myDeletable (alike in the Array2). For naming
* compatibility the method IsAllocated remained in class along
* with IsDeletable.
*/
//! The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time.
//! The range of the index is user defined.
//! An array1 can be constructed with a "C array".
//! This functionality is useful to call methods expecting an Array1.
//! It allows to carry the bounds inside the arrays.
//!
//! Examples:
//! @code
//! Item tab[100]; // an example with a C array
//! NCollection_Array1<Item> ttab (tab[0], 1, 100);
//!
//! NCollection_Array1<Item> tttab (ttab(10), 10, 20); // a slice of ttab
//! @endcode
//! If you want to reindex an array from 1 to Length do:
//! @code
//! NCollection_Array1<Item> tab1 (tab (tab.Lower()), 1, tab.Length());
//! @endcode
//! Warning: Programs client of such a class must be independent of the range of the first element.
//! Then, a C++ for loop must be written like this
//! @code
//! for (i = A.Lower(); i <= A.Upper(); i++)
//! @endcode
template <class TheItemType>
class NCollection_Array1
{