Skip to content

Commit 4b05054

Browse files
committed
Update comments
Signed-off-by: Darby Johnston <[email protected]>
1 parent a3f5fbd commit 4b05054

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

doxygen/config/dox_config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ INLINE_INFO = YES
643643
# name. If set to NO, the members will appear in declaration order.
644644
# The default value is: YES.
645645

646-
SORT_MEMBER_DOCS = NO
646+
SORT_MEMBER_DOCS = NO # Keep the same order as the header files
647647

648648
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
649649
# descriptions of file, namespace and class members alphabetically by member

src/opentime/timeRange.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ namespace opentime { namespace OPENTIME_VERSION {
1212

1313
/// @brief This default epsilon_s value is used in comparison between floating numbers.
1414
///
15-
/// It is computed to be twice 192khz, the fastest commonly used audio rate. It
16-
/// can be changed in the future if necessary due to higher sampling rates or
17-
/// some other kind of numeric tolerance detected in the library.
15+
/// It is computed to be twice 192kHz, the fastest commonly used audio rate. That gives
16+
/// a resolution of half a frame at 192kHz. The value can be changed in the future if
17+
/// necessary, due to higher sampling rates or some other kind of numeric tolerance
18+
/// detected in the library.
1819
constexpr double DEFAULT_EPSILON_s = 1.0 / (2 * 192000.0);
1920

2021
/// @brief This class represents a time range defined by a start time and duration.

0 commit comments

Comments
 (0)