Docs: Comprehensive project documentation update#12
Merged
JacobBorden merged 1 commit intodevelopmentfrom May 31, 2025
Merged
Conversation
This commit includes extensive updates to the project's documentation:
1. **README.md**:
* I verified and updated the "Features" section to accurately reflect current library capabilities, distinguishing between the old API and the new `BmpTool` API.
* I clarified "Dependencies" and "Core Modules" sections.
* I improved the `BmpTool` API explanation and replaced the example with a more comprehensive one from `main.cpp`, demonstrating a full load-process-save cycle.
* I updated "Building the Project" with more detailed instructions and clarified test execution.
* I added a "Code Documentation" section explaining Doxygen usage for `include/bitmap.hpp` and providing instructions for local documentation generation.
* I added a "Contributing" section with basic guidelines.
2. **src/matrix/Documentation/Matrix.MD**:
* I performed a thorough review and update to align with `src/matrix/matrix.h`.
* I corrected descriptions for iterator template parameters, operator behaviors, and const-correctness.
* I documented previously undocumented constructors, destructors, assignment operators, and member functions for `MatrixRow<T>` and `Matrix<T>`.
* I updated function signatures, return types (e.g., for in-place methods and compound assignment operators), and parameter types to match the current implementation.
* I clarified differences between `at()` (bounds-checked) and `operator[]` (no bounds-checking).
* I revised the "Potential Improvements" section to reflect implemented features and add new suggestions.
* I updated usage examples.
3. **CHANGELOG.md**:
* I added entries under version 0.3.0 to record the significant updates made to `README.md` and `src/matrix/Documentation/Matrix.MD`.
These changes ensure that the project documentation is current, accurate, and provides comprehensive guidance for you and contributors.
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
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 commit includes extensive updates to the project's documentation:
README.md:
BmpToolAPI.BmpToolAPI explanation and replaced the example with a more comprehensive one frommain.cpp, demonstrating a full load-process-save cycle.include/bitmap.hppand providing instructions for local documentation generation.src/matrix/Documentation/Matrix.MD:
src/matrix/matrix.h.MatrixRow<T>andMatrix<T>.at()(bounds-checked) andoperator[](no bounds-checking).CHANGELOG.md:
README.mdandsrc/matrix/Documentation/Matrix.MD.These changes ensure that the project documentation is current, accurate, and provides comprehensive guidance for you and contributors.