Add Doxygen comments to opentime#1866
Merged
darbyjohnston merged 4 commits intoAcademySoftwareFoundation:mainfrom Apr 3, 2025
Merged
Add Doxygen comments to opentime#1866darbyjohnston merged 4 commits intoAcademySoftwareFoundation:mainfrom
darbyjohnston merged 4 commits intoAcademySoftwareFoundation:mainfrom
Conversation
Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>
Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
❌ Your changes status has failed because you have indirect coverage changes. Learn more about Unexpected Coverage Changes and reasons for indirect coverage changes. Additional details and impacted files@@ Coverage Diff @@
## main #1866 +/- ##
==========================================
+ Coverage 84.11% 84.72% +0.61%
==========================================
Files 198 177 -21
Lines 22241 12809 -9432
Branches 4687 1191 -3496
==========================================
- Hits 18709 10853 -7856
+ Misses 2610 1773 -837
+ Partials 922 183 -739
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 127 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
ssteinbach
reviewed
Apr 1, 2025
Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>
ssteinbach
approved these changes
Apr 2, 2025
darbyjohnston
merged commit d876062
into
AcademySoftwareFoundation:main
62 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change completes adding Doxygen style comments to the opentime API. The changes are just comments, there are no functional changes to the API.
Most of the comments were straightforward, but any feedback to help improve them is welcome.
I added a Doxygen group for the TimeRange "relations" and
<pre>tags to keep the ASCII diagrams intact in the Doxygen HTML.I also made a couple of tweaks to the Doxygen configuration to remove non-public info and keep the sorting order the same as the header files.