-
Notifications
You must be signed in to change notification settings - Fork 999
Dot at the end of a doxygen comment #3082
Comments
No, these are all brief descriptions, because they are one line
From config file:
|
The dot is used to mark the end of the brief description only if JAVADOC_AUTOBRIEF option is enabled
and works only for multiline comments
|
For experiments:
|
Actually we have such a problem:
interpreted as a detailed description without brief description. So I think MULTILINE_CPP_IS_BRIEF should be enabled https://rurho3d.github.io/doxygen/class_urho3_d_1_1_spline_path.html |
Maybe I had run into something with it with a different project, then. Or perhaps I was completely mistaken and was remembering seeing something like the problem of it lacking the brief description for some members before. I'm not sure. I'm glad you were able to fix that one issue at least. In terms of this issue, I think I favor no period at the end on the doxygen comments if we want to change the current behavior, as many aren't really sentences ("Destructor.") and that saves a (small) number of bytes per file (unless there are multiple sentences for a single item in the documentation, I think). |
At the moment we have a rule to put dot at the end of a doxygen comment:
/// Blah blah blah.
and do not put dot at the end of a regular comment:
// Blah blah blah
Doxygen automatically adds dots in some pages (example) and automatically removes dots in other places (example).
Is there any reason to use a different style for regular and Doxygen comments?
The text was updated successfully, but these errors were encountered: