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

Explore markdown comments #733

Open
alandefreitas opened this issue Nov 19, 2024 · 0 comments
Open

Explore markdown comments #733

alandefreitas opened this issue Nov 19, 2024 · 0 comments

Comments

@alandefreitas
Copy link
Collaborator

Doxygen's language:

  • It's poorly documented enough to develop a second independent implementation in Clang, and there will always be conflicts.
  • Has lots of historical cruft
  • Is unique, that is, no other language uses it besides similar versions in Javadoc (the original tool for Java) and Javascript doc comments

Doxygen itself already supports HTML like commands.

As for Markdown:

  • There are parsers under permissive licenses
  • The most important commands are simple to implement
  • Markdown quickly became a de-facto standard for plain text markup, so it could drive adoption.
  • Very few people ever learn advanced concepts of Doxygen, but many already know ins and outs of Markdown.
  • Languages that appeared within the last decade, like Swift and Rust, use Markdown for documentation comments (they use custom limited implementations)
@alandefreitas alandefreitas moved this to Accepted in MrDocs Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Accepted
Development

No branches or pull requests

1 participant