[3rdParty] libE57: fix comment typos found by the spellchecker CI

This commit is contained in:
Uwe
2022-03-12 20:20:18 +01:00
parent 3b395ed856
commit ebd92016af
10 changed files with 21 additions and 21 deletions

View File

@@ -191,7 +191,7 @@ namespace e57
{
// don't checkImageFileOpen
/// Since only called for prototype nodes, should't be able to get here since
/// Since only called for prototype nodes, shouldn't be able to get here since
/// CompressedVectors can't be in prototypes
throw E57_EXCEPTION2( E57_ERROR_INTERNAL, "this->pathName=" + this->pathName() );
}

View File

@@ -119,7 +119,7 @@ std::shared_ptr<Decoder> Decoder::DecoderFactory( unsigned bytestreamNumber, //!
unsigned bitsPerRecord = imf->bitsNeeded( sini->minimum(), sini->maximum() );
//!!! need to pick smarter channel buffer sizes, here and elsewhere
/// Constuct ScaledInteger dencoder with appropriate register size,
/// Construct ScaledInteger dencoder with appropriate register size,
/// based on number of bits stored.
if ( bitsPerRecord == 0 )
{
@@ -251,7 +251,7 @@ size_t BitpackDecoder::inputProcess( const char *source, const size_t availableB
/// Now that we have input stored in an aligned buffer, call derived class
/// to try to eat some Note that end of filled buffer may not be at a
/// natural boundary. The subclass may transfer this partial word in a
/// full word transfer, but it must be carefull to only use the defined
/// full word transfer, but it must be done carefully to only use the defined
/// bits. inBuffer_ is a multiple of largest word size, so this full word
/// transfer off the end will always be in defined memory.
@@ -512,11 +512,11 @@ size_t BitpackStringDecoder::inputProcessAligned( const char *inbuf, const size_
{
if ( *inbuf & 0x01 )
{
prefixLength_ = 8; // 8 byte prefix, length upto 2^63-1
prefixLength_ = 8; // 8 byte prefix, length up to 2^63-1
}
else
{
prefixLength_ = 1; // 1 byte prefix, length upto 2^7-1
prefixLength_ = 1; // 1 byte prefix, length up to 2^7-1
}
}

View File

@@ -35,7 +35,7 @@ namespace e57
@brief Object thrown by E57 API functions to communicate the conditions of an
error.
@details
The E57Exception object communicates information about errors occuring in calls
The E57Exception object communicates information about errors occurring in calls
to the E57 API functions. The error information is communicated from the
location in the E57 implementation where the error was detected to the @c catch
statement in the code of the API user. The state of E57Exception object has one
@@ -87,7 +87,7 @@ namespace e57
available about nodes in the tree. So if the ImageFile is closed (by calling
ImageFile::close), the API user must be ready for many of the API functions to
throw E57Exception(E57_ERROR_IMAGEFILE_NOT_OPEN). Secondly, regarding the
E57_ERROR_INTERNAL error, there is a lot of consistancy checking in the
E57_ERROR_INTERNAL error, there is a lot of consistency checking in the
Reference Implementation, and there may be much more added. Even if some API
routines do not now throw E57_ERROR_INTERNAL, they could some time in the
future, or in different implementations. So the right to throw

View File

@@ -940,7 +940,7 @@ out as root nodes. It is possible to temporarily create small trees that are
unattached to any ImageFile. In these temporary trees, the top-most node will be
a root node. After the tree is attached to the ImageFile tree, the only root
node will be the pre-created one of the ImageTree (the one returned by
ImageFile::root). The concept of @em attachement is slightly larger than that of
ImageFile::root). The concept of @em attachment is slightly larger than that of
the parent-child relationship (see Node::isAttached and
CompressedVectorNode::CompressedVectorNode for more details).
@pre The destination ImageFile must be open (i.e. destImageFile().isOpen()).
@@ -968,7 +968,7 @@ types, but a parent node can only be one of the 3 container node types
(E57_STRUCTURE, E57_VECTOR, and E57_COMPRESSED_VECTOR). Each parent-child link
has a string name (the elementName) associated with it (See Node::elementName
for more details). More than one tree can be formed at any given time. Typically
small trees are temporarily constructed before attachement to an ImageFile so
small trees are temporarily constructed before attachment to an ImageFile so
that they will be written to the disk.
@b Warning: user algorithms that use this function to walk the tree must take
@@ -1173,7 +1173,7 @@ before and after any operation on the object. An invariant is useful for testing
correct operation of an implementation. Statements in an invariant can involve
only externally visible state, or can refer to internal implementation-specific
state that is not visible to the API user. The following C++ code checks
externally visible state for consistancy and throws an exception if the
externally visible state for consistency and throws an exception if the
invariant is violated:
@dontinclude E57Format.cpp
@skip begin StructureNode::checkInvariant
@@ -3303,7 +3303,7 @@ before and after any operation on the object. An invariant is useful for testing
correct operation of an implementation. Statements in an invariant can involve
only externally visible state, or can refer to internal implementation-specific
state that is not visible to the API user. The following C++ code checks
externally visible state for consistancy and throws an exception if the
externally visible state for consistency and throws an exception if the
invariant is violated:
@dontinclude E57Format.cpp
@skip begin ScaledIntegerNode::checkInvariant

View File

@@ -75,7 +75,7 @@ std::shared_ptr<Encoder> Encoder::EncoderFactory( unsigned bytestreamNumber,
unsigned bitsPerRecord = imf->bitsNeeded( ini->minimum(), ini->maximum() );
//!!! need to pick smarter channel buffer sizes, here and elsewhere
/// Constuct Integer encoder with appropriate register size, based on
/// Construct Integer encoder with appropriate register size, based on
/// number of bits stored.
if ( bitsPerRecord == 0 )
{
@@ -123,7 +123,7 @@ std::shared_ptr<Encoder> Encoder::EncoderFactory( unsigned bytestreamNumber,
unsigned bitsPerRecord = imf->bitsNeeded( sini->minimum(), sini->maximum() );
//!!! need to pick smarter channel buffer sizes, here and elsewhere
/// Constuct ScaledInteger encoder with appropriate register size,
/// Construct ScaledInteger encoder with appropriate register size,
/// based on number of bits stored.
if ( bitsPerRecord == 0 )
{

View File

@@ -392,7 +392,7 @@ namespace e57
ImageFileImpl::~ImageFileImpl()
{
/// Try to cancel if not already closed, but don't allow any exceptions to
/// propogate to caller (because in dtor). If writing, this will unlink the
/// propagate to caller (because in dtor). If writing, this will unlink the
/// file, so make sure call ImageFileImpl::close explicitly before dtor runs.
try
{

View File

@@ -474,7 +474,7 @@ char *DataPacket::getBytestream( unsigned bytestreamNumber, unsigned &byteCount
auto bsbLength = reinterpret_cast<uint16_t *>( &payload[0] );
auto streamBase = reinterpret_cast<char *>( &bsbLength[header.bytestreamCount] );
/// Sum size of preceeding stream buffers to get position
/// Sum size of preceding stream buffers to get position
unsigned totalPreceeding = 0;
for ( unsigned i = 0; i < bytestreamNumber; i++ )
{

View File

@@ -388,7 +388,7 @@ int64_t SourceDestBufferImpl::getNextInt64( double scale, double offset )
/// Reverse scale (undo scaling) of a user's number to get raw value to put
/// in file.
/// Encorporating the scale is optional (requested by user when constructing
/// Incorporating the scale is optional (requested by user when constructing
/// the sdbuf). If the user did not request scaling, then we get raw values
/// from user's buffer.
if ( !doScaling_ )
@@ -804,10 +804,10 @@ void SourceDestBufferImpl::setNextInt64( int64_t value, double scale, double off
{
/// don't checkImageFileOpen
/// Apply a scale and offset to numbers from file before puting in user's
/// Apply a scale and offset to numbers from file before putting in user's
/// buffer.
/// Encorporating the scale is optional (requested by user when constructing
/// Incorporating the scale is optional (requested by user when constructing
/// the sdbuf). If the user did not request scaling, then we send raw values
/// to user's buffer.
if ( !doScaling_ )

View File

@@ -106,7 +106,7 @@ namespace e57
size_t currentPosition = 0;
size_t len = value_.length();
/// Loop, searching for occurences of "]]>", which will be split across
/// Loop, searching for occurrences of "]]>", which will be split across
/// two CDATA directives
while ( currentPosition < len )
{
@@ -119,7 +119,7 @@ namespace e57
break;
}
/// Must output in two pieces, first send upto end of "]]" (don't send
/// Must output in two pieces, first send up to end of "]]" (don't send
/// the following ">").
cf << value_.substr( currentPosition, found - currentPosition + 2 );

View File

@@ -907,7 +907,7 @@ namespace e57
// E57_EXT_surface_normals
if ( data3DHeader.pointFields.normalX || data3DHeader.pointFields.normalY || data3DHeader.pointFields.normalZ )
{
// make sure we declare the extesion before using the fields with prefix
// make sure we declare the extension before using the fields with prefix
ustring norExtUri;
if ( !imf_.extensionsLookupPrefix( "nor", norExtUri ) )
{