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

Support qdoc markup #784

Open
1 task done
veshivas opened this issue Mar 3, 2024 · 0 comments
Open
1 task done

Support qdoc markup #784

veshivas opened this issue Mar 3, 2024 · 0 comments

Comments

@veshivas
Copy link

veshivas commented Mar 3, 2024

Check for existing issues

  • Completed

Describe the feature

QDoc is a markup specifically used by the Qt opensource project to document the APIs and the products. The markup is similar to LaTex (or Markdown to some extent) and is the only way to document an API in qtproject. Considering the size of the codebase, using a linter like vale is the only alternative to ensure consistency in the documentation.

For more information about qdoc, refer to the manual.

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