Fix Doxygen warnings: document the source only, with a main page

Refs #17
Merge pull request 'MIL-003 README, source documentation and screenshots' (#28 ) from mil-003-documentation into main
2026-10-13 15:41:11 +08:00 · 2026-10-13 09:40:24 +02:00
2 changed files with 32 additions and 20 deletions
@@ -7,10 +7,9 @@ PROJECT_NAME           = "Squirrel Census"
 PROJECT_BRIEF          = "Count squirrels by primary fur colour"
 PROJECT_NUMBER         = 0.1.0
 OUTPUT_DIRECTORY       = docs/doxygen
-INPUT                  = src README.md
-FILE_PATTERNS          = *.py *.md
+INPUT                  = src docs/mainpage.dox
+FILE_PATTERNS          = *.py *.dox
 RECURSIVE              = YES
-USE_MDFILE_AS_MAINPAGE = README.md
 OPTIMIZE_OUTPUT_JAVA   = YES
 EXTRACT_ALL            = YES
 GENERATE_HTML          = YES
@@ -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.
+*/
Author	SHA1	Message	Date
Tirsvad	b0132498ba	Fix Doxygen warnings: document the source only, with a main page Tests / Run the tests (pull_request) Successful in 40s Details Refs #17	2026-10-13 15:41:11 +08:00
Tirsvad	933f71eb39	Merge pull request 'MIL-003 README, source documentation and screenshots' (#28 ) from mil-003-documentation into main Tests / Run the tests (push) Canceled after 0s Details TirSystem/github-action: Sync GitHub mirror metadata / sync-metadata (push) Successful in 6s Details	2026-10-13 09:40:24 +02:00