Repository navigation
Add Doxygen comments to src/unidesk - #35
Merged
Merged
Conversation
TolisSth
approved these changes
Oct 25, 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 #28
Doxygen was already set up on main through the CI work in #33, so this PR is the documentation part of the issue.
What changed
PYTHON_DOCSTRING = NO(one line). With YES, Doxygen shows docstrings as plain text and ignores@brief,@paramand@return. With NO, it reads them as Doxygen comments, so the generated pages get file descriptions, parameter tables and return values.src/unideskare now in Doxygen style (@file,@brief,@param,@return), one commit per file. No code changes.<name>and<filename>placeholders intext_data.pyandloader.pywere rewritten, because Doxygen read them as HTML tags and warned.Checked
doxygen Doxyfilegives no warnings.pylint src/unideskis still clean (0 messages before and after).Left out on purpose
EXTRACT_PRIVATE = NO), functions nested inside other functions, empty__init__.pyfiles andsetup.py(not inINPUT).Question
EXTRACT_ALLis still YES, so Doxygen does not warn about undocumented code, and a "warnings must not increase" check would have almost nothing to catch. With it set to NO, Doxygen reports 34 warnings right now: 20 for module-level constants (UI,PAGES,CONFIG_PATHand similar) and 14 for private methods and attributes ofUniOSWelcomeinmain_window.py. Two of those (_toggle_autostartand_show_academic_config) are Doxygen reading the.connect(...)lines as variables, so docstrings cannot fix them.I left
EXTRACT_ALLon so this PR stays about the docstrings. Should I document the constants and private helpers and switch it in a follow-up, or leave that?