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 javadoc autobrief #665

Open
PlasmaHH opened this issue Nov 1, 2024 · 0 comments
Open

Support javadoc autobrief #665

PlasmaHH opened this issue Nov 1, 2024 · 0 comments

Comments

@PlasmaHH
Copy link

PlasmaHH commented Nov 1, 2024

This is not really a suggestion for a new documentation style but rather a setting for existing ones. All C and C++ styles start with @brief/\brief and then the description. Doxygen has an autobrief setting where it uses the first sentence before a . as the brief, thus making @brief/\brief unnecessary.

Duplicating the existing set of styles just for that one is probably not the best idea, but rather the introduction of a configuration that decides whether or not the brief part is written

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant