[Doxygen-users] Doxygen and check style issue
Brought to you by:
dimitri
|
From: sai m. <ts...@gm...> - 2015-09-23 05:38:33
|
Hi,
We are facing an issue with the below code i.e doxygen warning.
/**
* Check combo box selections by user.
* *@param* cmb javafx.scene.control.ComboBox
* *@param* failMsg Error message
* *@param* <T> This is the type parameter
* *@return* Returns True javafx.scene.control.ComboBox is Valid one
otherwise False
*/
*private* *static*<T> Boolean checkComboSelection(*final* ComboBox<T>
cmb, *final* String failMsg) {
}
1) In the line * *@param* <T> This is the type parameter a doxygen warning
is thrown “*warning: argument 'T' of command @param is not found in the
argument list of com.abc.xyz::checkComboSelection(final **ComboBox**< T > *
*cmb**, final String **failMsg**)”*
2) But when we replace <T> with *checkComboSelection *then we are getting a
*checkStyle* warning* “Unused @param tag for 'checkComboSelection'.”*
* *@**param* *checkComboSelection* This is the type parameter
In case "1" it is a doxygen warning and
In case "2" it is a check style warning.
Is there another way to write doxygen comment for that parameter?
Could anyone please help us fix this issue.
Thank you
Sai
|