Doxygen and check style issue

sai mrithyunjaya <[email protected]>
Newsgroups gmane.text.doxygen.general
Message-ID <CAMjuWWV-9UKkTg2Vv8jBRqCZzGYv5y50OdwDxDkT0POkxfD7-g@mail.gmail.com>
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

------------------------------------------------------------------------------
Monitor Your Dynamic Infrastructure at Any Scale With Datadog!
Get real-time metrics from all of your servers, apps and tools
in one place.
SourceForge users - Click here to start your Free Trial of Datadog now!
http://pubads.g.doubleclick.net/gampad/clk?id=241902991&iu=/4140

_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.