docs(core): adds doxygen comments in every hpp file#18
Merged
Conversation
Deleted the ObjReader library and its related header files from the vendor directory. Updated CMakeLists.txt to remove references to ObjReader. Added missing include for Prism/vector.hpp in Prism material.hpp to maintain required functionality.
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Matrix transformation API, updates all call sites and tests to the new signatures, and enriches the public headers with Doxygen comments.
- Changed Matrix::translation/scaling/rotation factories from dimension+list to explicit parameter APIs
- Updated tests and usage in
main.cppto match the new Matrix API - Added Doxygen-style documentation to all public header files
Reviewed Changes
Copilot reviewed 28 out of 37 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/src/TransformationsTest.cpp | Removed old dimension/list syntax, updated Matrix calls |
| tests/src/MatrixTest.cpp | Adjusted default-constructor test, removed deprecated tests |
| src/main.cpp | Wrapped long constructor call, updated Matrix calls |
| libs/Prism/include/Prism/**/*.hpp | Added comprehensive Doxygen comments to public APIs |
| libs/Prism/src/matrix.cpp | Reworked storage, proxies, and factory implementations |
Comments suppressed due to low confidence (5)
tests/src/TransformationsTest.cpp:18
- Update or remove this comment so it reflects the new
Matrix::translation(tx, ty, tz)signature instead of the old dimension+list API.
// CORREÇÃO: Passando a dimensão (3D) e a lista de valores
libs/Prism/include/Prism/objects.hpp:73
- [nitpick] Returning the transform matrix by value may incur unnecessary copying. Consider returning a
const Matrix&for better performance and consistency.
Matrix getTransform() const {
tests/src/MatrixTest.cpp:54
- [nitpick] Consider removing this commented-out test entirely if out-of-range checks are no longer supported to keep the test suite concise.
// NOTA: A checagem de acesso fora dos limites não é mais feita para performance.
src/main.cpp:54
- The angle
45is passed directly—likely degrees—into a function expecting radians (cos(angle)). Convert degrees to radians or clarify the expected unit.
teste * Prism::Matrix::rotation(45, {1, 0, 0}) * Prism::Matrix::scaling(0.5, 0.5, 0.5));
libs/Prism/include/Prism/Colormap.hpp:29
- [nitpick] Avoid
using namespace std;in a header file to prevent polluting the global namespace for all including translation units.
using namespace std;
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.
No description provided.