doxygen-users

[Doxygen-users] Doxygen and check style issue

[sai m. <ts...@gm...>]

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

Re: [Doxygen-users] Doxygen and check style issue

[Richard D. <Ri...@Da...>]

On 9/23/15 1:38 AM, sai mrithyunjaya wrote:
>
> 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
>
The issue is that <T> is not a parameter of the function, so @param is 
complaining. I think you want @tparam instead.

-- 
Richard Damon