Header Re-Organization for Consistency and Readability #497
Conversation
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
MathewBensonCode
force-pushed
the
header-reorganization
branch
2 times, most recently
from
1fa0077 to
1c3b16f
Compare
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
1c3b16f to
b9abaee
Compare
- Provide a consistent taxonomy for headers, where the libraries(ZEngine and Tetragrama) expose their Interface(the -I flag) as the root of the package and header naming is synchronized with namespaces - This is especially important in libraries like Tetragrama where you have headers from ZEngine and Tetragrama in the same header file - Make the CMake files cleaner and more consistent by having a uniform naming convention for the Targets
MathewBensonCode
force-pushed
the
header-reorganization
branch
from
b9abaee to
4c95667
Compare
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 commit touches on many files, but the work done is mainly adding the name of the project and the full path to the actual header file. e.g. going from
#include <ZEngineDef.h>to#include <ZEngine/ZEngineDef.h>Related to #310 , there may be need to harmonize the structure of the CMakeFiles, either all match the ZEngine format with the Main subdirectory defining the project and then containing another subdirectory with the targets or to use the format in Tetragrama and Obelisk where the targets and project are in the main Subdirectory.