Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CHORE] Remove legacy code from comments #48

Open
2 tasks
jgabaut opened this issue Nov 13, 2023 · 1 comment
Open
2 tasks

[CHORE] Remove legacy code from comments #48

jgabaut opened this issue Nov 13, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jgabaut
Copy link
Owner

jgabaut commented Nov 13, 2023

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.

Steps

  • Add a legacy_docs.c file to hold meaningful definitions that would be nice to parse with doxygen.

  • Blame legacy commented sections, looking for the big ones.

    • For all important ones:
    • Add info about the last tag to use this legacy section to the relevant legacy_docs.c part
    • Add this legacy section to legacy_docs.c either as a function printing the legacy source code snippets, or as a single string constant.
    • Open a PR
@jgabaut jgabaut added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Nov 13, 2023
@jgabaut
Copy link
Owner Author

jgabaut commented Nov 13, 2023

Merging this would also need the eventual Github Pages deploy to account for the legacy code at some point. See #50.

@jgabaut jgabaut changed the title Remove legacy code from comments [CHORE] Remove legacy code from comments Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant