tukaani-project / xz

XZ Utils
https://tukaani.org/xz/
Other
542 stars 101 forks source link

Minor updates to Doxygen comments in base.h #23

Closed JiaT75 closed 1 year ago

JiaT75 commented 1 year ago

Pull request checklist

Please check if your PR fulfills the following requirements:

Pull request type

Please check the type of change your PR introduces: - [ ] Bugfix - [ ] Feature - [ ] Code style update (formatting, renaming, typo fix) - [ ] Refactoring (no functional changes, no api changes) - [ ] Build related changes - [X] Documentation content changes - [ ] Other (please describe): ## What is the current behavior?

Related Issue URL:

What is the new behavior?

Does this introduce a breaking change?

Other information

Minor updates to base.h API header file. I plan to do similar changes to each API header file, but I figured its a good idea to review the first one or two so we agree on the changes needed.