Tirsvad-Udemy-100-days-of-code/025-squirrel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix Doxygen warnings #29

Merged
Tirsvad merged 1 commits from fix-doxygen-warnings into main 2026-10-13 09:41:24 +02:00
Conversation 0 Commits 1 Files Changed 2
+32 -20
2 changed files with 32 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Doxyfile
+19 -20
View File
@@ -1,20 +1,19 @@
# Doxygen configuration for the squirrel census project. # Doxygen configuration for the squirrel census project.
# Build the source documentation with: doxygen Doxyfile # Build the source documentation with: doxygen Doxyfile
# Output goes to docs/doxygen/ (ignored by git). Everything not listed here # Output goes to docs/doxygen/ (ignored by git). Everything not listed here
# keeps the Doxygen default. # keeps the Doxygen default.
PROJECT_NAME = "Squirrel Census" PROJECT_NAME = "Squirrel Census"
PROJECT_BRIEF = "Count squirrels by primary fur colour" PROJECT_BRIEF = "Count squirrels by primary fur colour"
PROJECT_NUMBER = 0.1.0 PROJECT_NUMBER = 0.1.0
OUTPUT_DIRECTORY = docs/doxygen OUTPUT_DIRECTORY = docs/doxygen
INPUT = src README.md INPUT = src docs/mainpage.dox
FILE_PATTERNS = *.py *.md FILE_PATTERNS = *.py *.dox
RECURSIVE = YES RECURSIVE = YES
USE_MDFILE_AS_MAINPAGE = README.md OPTIMIZE_OUTPUT_JAVA = YES
OPTIMIZE_OUTPUT_JAVA = YES EXTRACT_ALL = YES
EXTRACT_ALL = YES GENERATE_HTML = YES
GENERATE_HTML = YES GENERATE_LATEX = NO
GENERATE_LATEX = NO QUIET = YES
QUIET = YES WARN_IF_UNDOCUMENTED = YES
WARN_IF_UNDOCUMENTED = YES WARN_AS_ERROR = NO
WARN_AS_ERROR = NO
docs/mainpage.dox
+13
View File
@@ -0,0 +1,13 @@
/**
@mainpage Squirrel Census
Count the squirrels of the 2018 Central Park Squirrel Census by primary fur colour
(Gray, Cinnamon, Black) and export the counts to `squirrel_count.csv`.
The steps follow the Udemy "100 Days of Code" lecture of day 25: squirrel.census.read_csv,
squirrel.census.count_by_fur_color, squirrel.census.build_summary and
squirrel.census.write_csv. The command line entry point is squirrel.cli.main, started
with `python -m squirrel`. Every literal is defined once in squirrel.constants.
The package uses only the Python standard library.
*/