Refactor Header Files for Improved Readability and Reduced Risk of Name Collisions #14
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.
Summary
Propose refactoring the header files to improve readability and reduce the risk of name collisions.
Changes Made
PPL/srctoPPL/include/PPLfor a more standard project layout.PPL/srcto maintain backwards compatibility.Benefits
PPL/include/PPLreduces the risk of name collisions, especially for common names likesettings.h,log.h,processor.h,texture.h, andaction.h. This change necessitates using the include style#include "PPL/dataref.h", clearly distinguishing PPL headers from others.#include "PPL/dataref.h"makes it clear which library the header belongs to, improving code readability and reducing ambiguity.Context
Previously, users might have been adding
PPL/srcas an include directory and using statements like#include "dataref.h". This approach can lead to ambiguity and potential name collisions. By refactoring the project to usePPL/include/PPL, it becomes clear which library the headers belong to, and it aligns with common C++ practices.I believe these changes will improve the readability of the code and reduce the risk of name collisions.
Thank you for considering this request. Please let me know if you have any feedback or suggestions.