search

srcML / srcML

srcML Toolkit
srcml.org
GNU General Public License v3.0
118 stars 26 forks source link

Should doxygen be reported as a comment type in Java? #1659

Open mjdecker opened 5 years ago

mjdecker commented 5 years ago

Do we want to report doxygen style comments in Java as doxygen or Javadoc.

/** Javadoc */
/// doxygen
/*! not anything */

The first is currently marked up as javadoc and the second as doxygen, and the third is not either.

mlcollard commented 5 years ago

For clarification the only valid Javadoc style is:

/** Javadoc, also valid doxygen */

the others are not valid Javadoc, but are doxygen:

/// valid doxygen, (not javadoc )
/*! qt-style, valid doxygen (not javadoc) */
dtg3 commented 5 years ago

Given the source language it probably makes sense to give JavaDoc priority and the use Doxygen for any non-java doc lines. I'd probably still mark up lines that look like Doxygen as such since that could be valuable to know if they intended to have Doxygen of a certain style and mistakenly mixed them.

Is there a CLI option to specify the documentation type? That would allow people to override default behavior with their own preference.

mlcollard commented 5 years ago

No CLI option to specify the documentation type. For Java alone, the javadoc form is marked. For other forms, and for languages besides Java, the doxygen form is used, if valid doxygen

mjdecker commented 5 years ago

Sounds good. As Doxygen is valid for for Java