[skip CI] [3rdParty] libE57: fix comment typos found by the spellchecker CI
This commit is contained in:
@@ -46,7 +46,7 @@ namespace e57
|
||||
E57_ERROR_CHILD_INDEX_OUT_OF_BOUNDS = 3, //!< a numerical index identifying a child was out of bounds
|
||||
E57_ERROR_SET_TWICE = 4, //!< attempted to set an existing child element to a new value
|
||||
E57_ERROR_HOMOGENEOUS_VIOLATION = 5, //!< attempted to add an E57 Element that would have made the children
|
||||
//!< of a homogenous Vector have different types
|
||||
//!< of a homogeneous Vector have different types
|
||||
E57_ERROR_VALUE_NOT_REPRESENTABLE = 6, //!< a value could not be represented in the requested type
|
||||
E57_ERROR_SCALED_VALUE_NOT_REPRESENTABLE = 7, //!< after scaling the result could not be represented in the
|
||||
//!< requested type
|
||||
|
||||
@@ -38,7 +38,7 @@ namespace e57
|
||||
|
||||
//! Indicates to use FloatNode instead of ScaledIntegerNode in fields that can use both.
|
||||
constexpr double E57_NOT_SCALED_USE_FLOAT = 0.;
|
||||
//! Indicates to use ScaledIntegerNode insterad of FloatNode in fields that can use both.
|
||||
//! Indicates to use ScaledIntegerNode instead of FloatNode in fields that can use both.
|
||||
constexpr double E57_NOT_SCALED_USE_INTEGER = -1.;
|
||||
|
||||
//! @cond documentNonPublic The following isn't part of the API, and isn't documented.
|
||||
@@ -144,7 +144,7 @@ namespace e57
|
||||
double elevationMinimum; //!< The minimum extent of the bounding region from the horizontal plane
|
||||
double elevationMaximum; //!< The maximum extent of the bounding region from the horizontal plane
|
||||
double azimuthStart; //!< The starting azimuth angle defining the extent of the bounding region around the z axis
|
||||
double azimuthEnd; //!< The ending azimuth angle defining the extent of the bounding region around the z axix
|
||||
double azimuthEnd; //!< The ending azimuth angle defining the extent of the bounding region around the z axis
|
||||
|
||||
bool operator==( const SphericalBounds &rhs ) const
|
||||
{
|
||||
|
||||
@@ -54,7 +54,7 @@ namespace e57
|
||||
|
||||
//! @brief This function returns the file header information
|
||||
//! @param [out] fileHeader is the main header information
|
||||
//! @return Returns true if sucessful
|
||||
//! @return Returns true if successful
|
||||
bool GetE57Root( E57Root &fileHeader ) const;
|
||||
|
||||
//!@}
|
||||
@@ -69,7 +69,7 @@ namespace e57
|
||||
//! @brief This function returns the image2D header and positions the cursor
|
||||
//! @param [in] imageIndex This in the index into the image2D vector
|
||||
//! @param [out] image2DHeader pointer to the Image2D structure to receive the picture information
|
||||
//! @return Returns true if sucessful
|
||||
//! @return Returns true if successful
|
||||
bool ReadImage2D( int64_t imageIndex, Image2D &image2DHeader ) const;
|
||||
|
||||
//! @brief This function returns the size of the image data
|
||||
@@ -81,7 +81,7 @@ namespace e57
|
||||
//! @param [out] imageSize This is the total number of bytes for the image blob.
|
||||
//! @param [out] imageMaskType This is E57_PNG_IMAGE_MASK if "imageMask" is defined in the projection
|
||||
//! @param [out] imageVisualType This is image type of the VisualReferenceRepresentation if given.
|
||||
//! @return Returns true if sucessful
|
||||
//! @return Returns true if successful
|
||||
bool GetImage2DSizes( int64_t imageIndex, Image2DProjection &imageProjection, Image2DType &imageType,
|
||||
int64_t &imageWidth, int64_t &imageHeight, int64_t &imageSize, Image2DType &imageMaskType,
|
||||
Image2DType &imageVisualType ) const;
|
||||
@@ -109,7 +109,7 @@ namespace e57
|
||||
//! @brief This function returns the Data3D header
|
||||
//! @param [in] dataIndex This in the index into the images3D vector. Must be less than GetData3DCount().
|
||||
//! @param [out] data3DHeader Data3D header
|
||||
//! @return Returns true if sucessful
|
||||
//! @return Returns true if successful
|
||||
bool ReadData3D( int64_t dataIndex, Data3D &data3DHeader ) const;
|
||||
|
||||
//! @brief This function returns the size of the point data
|
||||
@@ -120,18 +120,18 @@ namespace e57
|
||||
//! @param [out] groupsSize This is the total number of group reocrds
|
||||
//! @param [out] countSize This is the maximum point count per group
|
||||
//! @param [out] columnIndex This indicates that the idElementName is "columnIndex"
|
||||
//! @return Return true if sucessful, false otherwise
|
||||
//! @return Return true if successful, false otherwise
|
||||
bool GetData3DSizes( int64_t dataIndex, int64_t &rowMax, int64_t &columnMax, int64_t &pointsSize,
|
||||
int64_t &groupsSize, int64_t &countSize, bool &columnIndex ) const;
|
||||
|
||||
//! @brief This funtion reads the group data into the provided buffers.
|
||||
//! @brief This function reads the group data into the provided buffers.
|
||||
//! @param [in] dataIndex This in the index into the images3D vector. Must be less than GetData3DCount().
|
||||
//! @param [in] groupCount size of each of the buffers given
|
||||
//! @param [out] idElementValue pointer to the buffer holding indices index for this group
|
||||
//! @param [out] startPointIndex pointer to the buffer holding Starting index in to the "points" data vector for
|
||||
//! the groups
|
||||
//! @param [out] pointCount pointer to the buffer holding size of the groups given
|
||||
//! @return Return true if sucessful, false otherwise
|
||||
//! @return Return true if successful, false otherwise
|
||||
bool ReadData3DGroupsData( int64_t dataIndex, int64_t groupCount, int64_t *idElementValue,
|
||||
int64_t *startPointIndex, int64_t *pointCount ) const;
|
||||
|
||||
|
||||
@@ -105,7 +105,7 @@ namespace e57
|
||||
//! @param [in] buffer of idElementValue index for this group
|
||||
//! @param [in] startPointIndex buffer with starting indices in to the "points" data vector for the groups
|
||||
//! @param [in] pointCount buffer with sizes of the groups given
|
||||
//! @return Return true if sucessful, false otherwise
|
||||
//! @return Return true if successful, false otherwise
|
||||
bool WriteData3DGroupsData( int64_t dataIndex, int64_t groupCount, int64_t *idElementValue,
|
||||
int64_t *startPointIndex, int64_t *pointCount );
|
||||
|
||||
|
||||
@@ -311,7 +311,7 @@ namespace e57
|
||||
case E57_ERROR_HOMOGENEOUS_VIOLATION:
|
||||
return "attempted to add an E57 Element that would have made the "
|
||||
"children of a "
|
||||
"homogenous Vector have different types "
|
||||
"homogeneous Vector have different types "
|
||||
"(E57_ERROR_HOMOGENEOUS_VIOLATION)";
|
||||
case E57_ERROR_VALUE_NOT_REPRESENTABLE:
|
||||
return "a value could not be represented in the requested type "
|
||||
|
||||
2
src/3rdParty/libE57Format/src/E57XmlParser.h
vendored
2
src/3rdParty/libE57Format/src/E57XmlParser.h
vendored
@@ -92,7 +92,7 @@ namespace e57
|
||||
int64_t length; // used in E57_BLOB
|
||||
bool allowHeterogeneousChildren; // used in E57_VECTOR
|
||||
int64_t recordCount; // used in E57_COMPRESSED_VECTOR
|
||||
ustring childText; // used by all types, accumlates all child text between tags
|
||||
ustring childText; // used by all types, accumulates all child text between tags
|
||||
|
||||
/// Holds node for Structure, Vector, and CompressedVector so can append
|
||||
/// child elements
|
||||
|
||||
2
src/3rdParty/libE57Format/src/NodeImpl.cpp
vendored
2
src/3rdParty/libE57Format/src/NodeImpl.cpp
vendored
@@ -213,7 +213,7 @@ bool NodeImpl::isTypeConstrained()
|
||||
/// Downcast to shared_ptr<VectorNodeImpl>
|
||||
std::shared_ptr<VectorNodeImpl> ai( std::static_pointer_cast<VectorNodeImpl>( p ) );
|
||||
|
||||
/// If homogenous vector and have more than one child, then can't
|
||||
/// If homogeneous vector and have more than one child, then can't
|
||||
/// change them
|
||||
if ( !ai->allowHeteroChildren() && ai->childCount() > 1 )
|
||||
{
|
||||
|
||||
2
src/3rdParty/libE57Format/src/ReaderImpl.cpp
vendored
2
src/3rdParty/libE57Format/src/ReaderImpl.cpp
vendored
@@ -1218,7 +1218,7 @@ namespace e57
|
||||
return true;
|
||||
}
|
||||
|
||||
// This funtion writes out the group data
|
||||
// This function writes out the group data
|
||||
bool ReaderImpl::ReadData3DGroupsData( int64_t dataIndex, int64_t groupCount, int64_t *idElementValue,
|
||||
int64_t *startPointIndex, int64_t *pointCount ) const
|
||||
{
|
||||
|
||||
2
src/3rdParty/libE57Format/src/ReaderImpl.h
vendored
2
src/3rdParty/libE57Format/src/ReaderImpl.h
vendored
@@ -94,7 +94,7 @@ namespace e57
|
||||
//! @param [out] imageHeight The image height (in pixels).
|
||||
//! @param [out] imageSize This is the total number of bytes for the image blob.
|
||||
//! @param [out] imageMaskType This is E57_PNG_IMAGE_MASK if "imageMask" is defined in the projection
|
||||
//! @return Returns true if sucessful
|
||||
//! @return Returns true if successful
|
||||
bool GetImage2DNodeSizes( StructureNode image, Image2DType &imageType, int64_t &imageWidth, int64_t &imageHeight,
|
||||
int64_t &imageSize, Image2DType &imageMaskType ) const;
|
||||
|
||||
|
||||
2
src/3rdParty/libE57Format/src/WriterImpl.cpp
vendored
2
src/3rdParty/libE57Format/src/WriterImpl.cpp
vendored
@@ -1069,7 +1069,7 @@ namespace e57
|
||||
template CompressedVectorWriter WriterImpl::SetUpData3DPointsData( int64_t dataIndex, size_t pointCount,
|
||||
const Data3DPointsData_t<double> &buffers );
|
||||
|
||||
// This funtion writes out the group data
|
||||
// This function writes out the group data
|
||||
bool WriterImpl::WriteData3DGroupsData( int64_t dataIndex, int64_t groupCount, int64_t *idElementValue,
|
||||
int64_t *startPointIndex, int64_t *pointCount )
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user