Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up some doxygen comments #207

Merged
merged 1 commit into from
Jan 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions include/E57Exception.h
Original file line number Diff line number Diff line change
Expand Up @@ -306,18 +306,20 @@ namespace e57
const char *sourceFunctionName() const noexcept;
int sourceLineNumber() const noexcept;

/// \cond documentNonPublic The following isn't part of the API, and isn't documented.
/// @cond documentNonPublic The following isn't part of the API, and isn't documented.
E57Exception() = delete;
E57Exception( ErrorCode ecode, std::string context, const char *srcFileName = nullptr,
int srcLineNumber = 0, const char *srcFunctionName = nullptr );
/// @endcond

private:
/// @cond documentNonPublic The following isn't part of the API, and isn't documented.
ErrorCode errorCode_;
std::string context_;
std::string sourceFileName_;
const char *sourceFunctionName_;
int sourceLineNumber_;
/// \endcond
/// @endcond
};

namespace Utilities
Expand Down
4 changes: 2 additions & 2 deletions src/CheckedFile.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ namespace
class e57::BufferView
{
public:
/// @param[IN] input: filled buffer owned by caller.
/// @param[IN] size: size of input
/// @param [in] input filled buffer owned by caller
/// @param [in] size size of input
BufferView( const char *input, uint64_t size ) : streamSize_( size ), stream_( input )
{
}
Expand Down
2 changes: 0 additions & 2 deletions src/CompressedVectorReader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ using namespace e57;
/*!
@brief Check whether CompressedVectorReader class invariant is true

@param [in] doRecurse If true, also check invariants of all children or sub-objects recursively.

@details
This function checks at least the assertions in the documented class invariant description (see
class reference page for this object). Other internal invariants that are implementation-dependent
Expand Down
1 change: 0 additions & 1 deletion src/ImageFile.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,6 @@ have all the required element names required by ASTM E57 file format standard us
@param [in] checksumPolicy The percentage of checksums we compute and verify as an int. Clamped to
0-100.

@details
@par Write Mode
In write mode, the file cannot be already open.
A file with name given by @a fname is immediately created on the disk.
Expand Down
1 change: 0 additions & 1 deletion src/IntegerNode.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ using namespace e57;
/*!
@brief Check whether IntegerNode class invariant is true

@param [in] doRecurse If true, also check invariants of all children or sub-objects recursively.
@param [in] doUpcast If true, also check invariants of the generic Node class.

@details
Expand Down