Clean up class access specifiers and other aspects #1136
Merged
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
This includes a number of whole-codebase changes to tidy up some inconsistent aspects of our classes, and to firm up class interfaces. - If class clients are expected to write or read member variables, those variables must be public, and are listed at the top of the class, immediately after the leading `public:` specifier. Constructors follow, followed by other public methods. After this is the `private:` section, beginning with private member variables, and concluding with other private functions. - Some classes are effectively immutable. Such classes should generally not have a default constructor unless such an object has useful meaning or other utility. These are basically classes with useful constructors and a body of private resulting member variables. - Fix some indentation errors in the books in code listings. - Tweaked some blank line spacing. - Fixed some code listing highlighting. All code recompiled, all renders executed and validated. Resolves #869
This was referenced Jun 6, 2023
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 includes a number of whole-codebase changes to tidy up some inconsistent aspects of our classes, and to firm up class interfaces.
If class clients are expected to write or read member variables, those variables must be public, and are listed at the top of the class, immediately after the leading
public:specifier. Constructors follow, followed by other public methods. After this is theprivate:section, beginning with private member variables, and concluding with other private functions.Some classes are effectively immutable. Such classes should generally not have a default constructor unless such an object has useful meaning or other utility. These are basically classes with useful constructors and a body of private resulting member variables.
Fix some indentation errors in the books in code listings.
Tweaked some blank line spacing.
Fixed some code listing highlighting.
All code recompiled, all renders executed and validated.
Resolves #869