Skip to content

Commit

Permalink
Fix doxygen comments on checksum policies
Browse files Browse the repository at this point in the history
Issue mentioned in #76
  • Loading branch information
asmaloney committed Sep 7, 2021
1 parent b5b7661 commit 95e8698
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions include/E57Format.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,14 @@ namespace e57
//! an ImageFile (0-100%).
using ReadChecksumPolicy = int;

constexpr ReadChecksumPolicy CHECKSUM_POLICY_NONE = 0; //! Do not verify the checksums. (fast)
constexpr ReadChecksumPolicy CHECKSUM_POLICY_SPARSE =
25; //! Only verify 25% of the checksums. The last block is always verified.
constexpr ReadChecksumPolicy CHECKSUM_POLICY_HALF =
50; //! Only verify 50% of the checksums. The last block is always verified.
constexpr ReadChecksumPolicy CHECKSUM_POLICY_ALL = 100; //! Verify all checksums. This is the default. (slow)
//! Do not verify the checksums. (fast)
constexpr ReadChecksumPolicy CHECKSUM_POLICY_NONE = 0;
//! Only verify 25% of the checksums. The last block is always verified.
constexpr ReadChecksumPolicy CHECKSUM_POLICY_SPARSE = 25;
//! Only verify 50% of the checksums. The last block is always verified.
constexpr ReadChecksumPolicy CHECKSUM_POLICY_HALF = 50;
//! Verify all checksums. This is the default. (slow)
constexpr ReadChecksumPolicy CHECKSUM_POLICY_ALL = 100;

//! @brief The URI of ASTM E57 v1.0 standard XML namespace
//! Note that even though this URI does not point to a valid document, the standard (section 8.4.2.3)
Expand Down

0 comments on commit 95e8698

Please sign in to comment.