[JIRA] (JENKINS-61855) Doxygen parser doesn't detect Doxygen Warnings

[nils.gerke@digitalwerk.net (JIRA)]

Nils Gerke created an issue

Jenkins / JENKINS-61855 Doxygen parser doesn't detect Doxygen Warnings Issue Type: Bug Assignee: Ulli Hafner Components: warnings-ng-plugin Created: 2020-04-09 14:10 Environment: Jenkins 2.222.1, Warnings Next Generation Plugin 8.1.0, Doxygen 1.8.13 Priority: Minor Reporter: Nils Gerke I got lots of Doxygen warnings similar to these: /repo/src/libraries/base/include/configuration.h(115): warning: Member Notify(const IProperty &oProperty) override (function) of class property_variable< T > is not documented. /repo/src/libraries/base/include/configuration.h(120): warning: Member GetType(IString &&strType) const override (function) of class property_variable< T > is not documented. /repo/src/libraries/base/include/configuration.h(125): warning: Member GetValue() const override (function) of class property_variable< T > is not documented. /repo/src/libraries/base/include/configuration.h(130): warning: Member operator*() const (function) of class property_variable< T > is not documented. /repo/src/libraries/base/include/configuration.h(135): warning: Member operator const T &() const (function) of class property_variable< T > is not documented. /repo/src/libraries/base/include/configuration.h(140): warning: Member operator==(const T &oVal) (function) of class property_variable< T > is not documented. /repo/src/libraries/base/include/configuration.h(145): warning: Member operator!=(const T &oVal) (function) of class property_variable< T > is not documented. But non of them is detected, instead the same warnings are detected as with the GCC parser. This might be related to JENKINS-60469 Add Comment

This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)

[ullrich.hafner@gmail.com (JIRA)]

Ulli Hafner assigned an issue to Unassigned

Jenkins / JENKINS-61855 Doxygen parser doesn't detect Doxygen Warnings

Change By: Ulli Hafner Component/s: analysis-model Component/s: warnings-ng-plugin Labels: help-wanted newbie-friendly Assignee: Ulli Hafner

Add Comment

[nils.gerke@digitalwerk.net (JIRA)]

Nils Gerke commented on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings Ulli Hafner if you give me a hint were to start, I would try fixing this. I guess the workflow would be to fork https://github.com/jenkinsci/analysis-model, assign this Issue to me and create a pull request when finished right?

Add Comment

[ullrich.hafner@gmail.com (JIRA)]

Ulli Hafner edited a comment on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings

Yes, that this is the right process. There are two options to solve the problem: either create a new parser or extend the existing GCC parser. Since the GCC parser already is quite complex I prefer the former option. Are there some Doxygen warnings that are recognized by the GCC parser already? Or are all the warnings in the form of the example in the description?

Add Comment

[ullrich.hafner@gmail.com (JIRA)]

Ulli Hafner commented on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings

Yes, that is the right process.

There are two options to solve the problem: either create a new parser or extend the existing GCC parser. Since the GCC parser already is quite complex I prefer the former option. Are there some Doxygen warnings that are recognized by the GCC parser already? Or are all the warnings in the form of the example in the description?

Add Comment

[nils.gerke@digitalwerk.net (JIRA)]

Nils Gerke assigned an issue to Nils Gerke

Jenkins / JENKINS-61855

Doxygen parser doesn't detect Doxygen Warnings

Change By: Nils Gerke Assignee: Nils Gerke

Add Comment

[ullrich.hafner@gmail.com (JIRA)]

Ulli Hafner commented on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings What also is possible: we can register multiple parsers for Doxygen. I.e., we can use the existing one and a new additional one that parses the messages from above.

Add Comment

[nils.gerke@digitalwerk.net (JIRA)]

Nils Gerke commented on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings

I've checked the logs and the GCC parser catches none of the Doxygen warnings, but the MSBuild parser catches all Doxygen warnings.  What would be the expected behavior? GCC/MSBuild Parser to catch the Doxygen warnings or GCC/MSBuild catching only compiler warning and a Doxygen parser catching Doxygen warnings. Depending on this I would choose if we should be going for the existing GCC parser or a new parser. For me personal the second case would be more intuitive.

Add Comment

[nils.gerke@digitalwerk.net (JIRA)]

Nils Gerke edited a comment on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings

I've checked the logs and the GCC parser catches none of the Doxygen warnings, but the MSBuild parser catches all Doxygen warnings.

What would be the expected behavior? GCC/MSBuild Parser to catch catching the Doxygen warnings or GCC/MSBuild catching only compiler warning warnings and a Doxygen parser catching Doxygen warnings. Depending on this I would choose if we should be going for the existing GCC parser or a new parser.

For me personal the second case would be more intuitive.

Add Comment

[ullrich.hafner@gmail.com (JIRA)]

Ulli Hafner commented on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings

I think it makes sense to start with a new parser. From the log shown in the description it looks like that this parser will be quite simple.

Add Comment

[ullrich.hafner@gmail.com (JIRA)]

Ulli Hafner edited a comment on JENKINS-61855

Re: Doxygen parser doesn't detect Doxygen Warnings

I think it makes sense to start with a new parser just for those Doxygen messages . From the log shown in the description it looks like that this parser will be quite simple.

Add Comment