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

Reformat documentation to use triple-slash doxygen format. #1658

Open
6 of 12 tasks
Dimi1010 opened this issue Dec 15, 2024 · 1 comment
Open
6 of 12 tasks

Reformat documentation to use triple-slash doxygen format. #1658

Dimi1010 opened this issue Dec 15, 2024 · 1 comment

Comments

@Dimi1010
Copy link
Collaborator

Dimi1010 commented Dec 15, 2024

Rationale:

  • Reduced line bloat. Each documentation block is 2 lines shorter on average.
    This can compound to over 100 lines on some of the larger files. (e.g. "IPAddress.h")
  • Makes usages of comment blocks /* */ easier to manage during refactoring, as they won't be terminated early if there are documentation comments inside them.

Progress summary:

@Dimi1010
Copy link
Collaborator Author

Dimi1010 commented Jan 17, 2025

Discontinued due to issues with #1659 .

@Dimi1010 Dimi1010 closed this as not planned Won't fix, can't repro, duplicate, stale Jan 17, 2025
@Dimi1010 Dimi1010 reopened this Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant