Open jgabaut opened 7 months ago
Situation
A lot of legacy code is embedded as comment and it's an eyesore. Removing it is due, but also a chore.
Maybe we should extract it to some "legacy docs" .c file that can be translated with doxygen, so the old code still retains some meaning.
.c
doxygen
Steps
[ ] Add a legacy_docs.c file to hold meaningful definitions that would be nice to parse with doxygen.
legacy_docs.c
[ ] Blame legacy commented sections, looking for the big ones.
Merging this would also need the eventual Github Pages deploy to account for the legacy code at some point. See #50.
Situation
A lot of legacy code is embedded as comment and it's an eyesore. Removing it is due, but also a chore.
Maybe we should extract it to some "legacy docs"
.c
file that can be translated withdoxygen
, so the old code still retains some meaning.Steps
[ ] Add a
legacy_docs.c
file to hold meaningful definitions that would be nice to parse withdoxygen
.[ ] Blame legacy commented sections, looking for the big ones.
legacy_docs.c
partlegacy_docs.c
either as a function printing the legacy source code snippets, or as a single string constant.