diff --git a/CHANGELOG.md b/CHANGELOG.md index b90cf72..d8681db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ All notable changes to this project will be documented in this file. The format ### Added -- Added Testing using [GoogleTest](https://github.com/google/googletest). For details, please see [test/README.md](test/README.md) ([#121](https://github.com/asmaloney/libE57Format/pull/121)) +- Added testing using [GoogleTest](https://github.com/google/googletest). For details, please see [test/README.md](test/README.md) ([#121](https://github.com/asmaloney/libE57Format/pull/121)) - Added `E57Exception::errorStr()` to get the error string directly. ([#128](https://github.com/asmaloney/libE57Format/pull/128)) - {cmake} Use [ccache](https://ccache.dev/) if available. ([#129](https://github.com/asmaloney/libE57Format/pull/129)) - {ci} Added a CI check for proper clang-formatted code. ([#125](https://github.com/asmaloney/libE57Format/pull/125)) diff --git a/include/E57Format.h b/include/E57Format.h index 882d854..24928f1 100644 --- a/include/E57Format.h +++ b/include/E57Format.h @@ -49,7 +49,7 @@ namespace e57 using std::uint8_t; // Shorthand for unicode string - //! @brief UTF-8 encodeded Unicode string + //! @brief UTF-8 encoded Unicode string using ustring = std::string; //! @brief Identifiers for types of E57 elements diff --git a/include/E57SimpleReader.h b/include/E57SimpleReader.h index d5cbfcf..4597b13 100644 --- a/include/E57SimpleReader.h +++ b/include/E57SimpleReader.h @@ -155,7 +155,7 @@ namespace e57 //! @brief Use this function to read the actual 3D data //! @details All the non-NULL buffers in buffers have number of elements = pointCount. //! Call the CompressedVectorReader::read() until all data is read. - //! @param [in] dataIndex data block index given by the NewData3D + //! @param [in] dataIndex data block index //! @param [in] pointCount size of each element buffer. //! @param [in] buffers pointers to user-provided buffers //! @return vector reader setup to read the selected data into the provided buffers @@ -165,7 +165,7 @@ namespace e57 //! @brief Use this function to read the actual 3D data //! @details All the non-NULL buffers in buffers have number of elements = pointCount. //! Call the CompressedVectorReader::read() until all data is read. - //! @param [in] dataIndex data block index given by the NewData3D + //! @param [in] dataIndex data block index //! @param [in] pointCount size of each element buffer. //! @param [in] buffers pointers to user-provided buffers //! @return vector reader setup to read the selected data into the provided buffers diff --git a/src/CompressedVectorReader.cpp b/src/CompressedVectorReader.cpp index ff6f446..aa1c949 100644 --- a/src/CompressedVectorReader.cpp +++ b/src/CompressedVectorReader.cpp @@ -217,7 +217,7 @@ unsigned CompressedVectorReader::read( std::vector &dbufs ) /*! @brief Set record number of CompressedVectorNode where next read will start. -@param [in] recordNumber The index of record in ComressedVectorNode where +@param [in] recordNumber The index of record in CompressedVectorNode where next read using this CompressedVectorReader will start. @details This function may be called at any time (as long as ImageFile and diff --git a/src/CompressedVectorReaderImpl.cpp b/src/CompressedVectorReaderImpl.cpp index fc99929..5315aa8 100644 --- a/src/CompressedVectorReaderImpl.cpp +++ b/src/CompressedVectorReaderImpl.cpp @@ -338,21 +338,18 @@ namespace e57 // Get packet at currentPacketLogicalOffset into memory. auto dpkt = dataPacket( currentPacketLogicalOffset ); - // Double check that have a data packet. Should have already determined - // this. + // Double check that have a data packet. Should have already determined this. if ( dpkt->header.packetType != DATA_PACKET ) { throw E57_EXCEPTION2( E57_ERROR_INTERNAL, "packetType=" + toString( dpkt->header.packetType ) ); } - // Read earliest packet into cache and send data to decoders with unblocked - // output + // Read earliest packet into cache and send data to decoders with unblocked output bool anyChannelHasExhaustedPacket = false; uint64_t nextPacketLogicalOffset = E57_UINT64_MAX; - // Feed bytestreams to channels with unblocked output that are reading from - // this packet + // Feed bytestreams to channels with unblocked output that are reading from this packet for ( DecodeChannel &channel : channels_ ) { // Skip channels that have already read this packet. diff --git a/src/Node.cpp b/src/Node.cpp index 92f2f6a..4799294 100644 --- a/src/Node.cpp +++ b/src/Node.cpp @@ -118,7 +118,7 @@ ScaledIntegerNode, FloatNode, StringNode, BlobNode /*! @brief Return the NodeType of a generic Node. @details This function allows the actual node type to be interrogated before -upcasting the handle to the actual node type (see Upcasting and Dowcasting +upcasting the handle to the actual node type (see Upcasting and Downcasting section in Node). @return The NodeType of a generic Node, which may be one of the following NodeType enumeration values: @@ -126,7 +126,7 @@ ::E57_STRUCTURE, ::E57_VECTOR, ::E57_COMPRESSED_VECTOR, ::E57_INTEGER, ::E57_SCALED_INTEGER, ::E57_FLOAT, ::E57_STRING, ::E57_BLOB. @post No visible state is modified. -@see NodeType, upcast/dowcast discussion in Node +@see NodeType, upcast/downcast discussion in Node */ NodeType Node::type() const {