Repository navigation
Add Doxygen and document applyTranslator.hpp and loadUniversities.hpp - #38
Merged
Merged
Conversation
Collaborator
|
Great idea and great work please implement the issues and take up the deployment of the github pages |
This was referenced Oct 10, 2026
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.
Closes #37
What
Doxyfile(generated withdoxygen -g, then configured in a separate commit so the diff shows only the changes)docs/outputUtils::loadUniversitiesandUtils::applyTranslator, plus file-level andUtilsnamespace docsDoxyfile choices
INPUT = include src README.md,RECURSIVE = YES,FILE_PATTERNS = *.hpp *.cppUSE_MDFILE_AS_MAINPAGE = README.md– README is the landing pageHAVE_DOT = NO– avoids a Graphviz dependency; can be switched on if we want class/include graphsMACRO_EXPANSION = YES+PREDEFINEDforQ_OBJECT/signals/slotsso Qt macros don't confuse the parserWARN_IF_UNDOCUMENTED = YES– the warnings double as a to-do listGENERATE_LATEX = NO– HTML onlyHow to build
Ideas / follow-ups