Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI] The deprecation list is showing weird things #3825

Closed
kunaltyagi opened this issue Mar 29, 2020 · 7 comments · Fixed by #3905
Closed

[CI] The deprecation list is showing weird things #3825

kunaltyagi opened this issue Mar 29, 2020 · 7 comments · Fixed by #3905
Labels
kind: bug Type of issue kind: todo Type of issue module: ci

Comments

@kunaltyagi
Copy link
Member

The deprecation list is showing weird things on https://pointcloudlibrary.github.io/documentation/deprecated.html but not on http://docs.pointclouds.org/trunk/deprecated.html.

EDIT: and CI is reporting this

/__w/1/s/common/include/pcl/common/io.h:82: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
/__w/1/s/common/include/pcl/common/io.h:111: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
/__w/1/s/common/include/pcl/common/io.h:121: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
/__w/1/s/common/include/pcl/common/io.h:335: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
/__w/1/s/common/include/pcl/point_cloud.h:142: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
/__w/1/s/segmentation/include/pcl/segmentation/supervoxel_clustering.h:291: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)

and more new ones

Originally posted by @aPonza in #3808 (comment)

@kunaltyagi kunaltyagi added kind: bug Type of issue kind: todo Type of issue module: ci labels Mar 29, 2020
@aPonza
Copy link
Contributor

aPonza commented Mar 29, 2020

But that PR #3701 didn't touch the same lines I did (in the header file).

I explained myself poorly: all of the warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) were gone after that #3701 which means some new ones were introduced. Some of these (if not all) coincide with the new PCL_DEPRECATED. This basically only means I have to hurry up if I want to see less new warnings in Documentation: the faster I fix all of them and turn on -Werror, the faster no new ones will arise.

@kunaltyagi
Copy link
Member Author

all of the ... were gone after

Gotcha. Could you also please tell me (if and when possible) how not to give rise these warnings 😅 ?

@aPonza
Copy link
Contributor

aPonza commented Mar 29, 2020

I'll have to see for myself, these ones are weird as no ; can be used since it's in the middle of a declaration. I'd have hoped doxygen-clang wouldn't show them, but I'm still waiting on a definitive answer there. Right now at least making it evident they are new should be doable (turn on warning as error once all of the warnings are gone).

@aPonza
Copy link
Contributor

aPonza commented Apr 11, 2020

So the error itself is because "." ends the period if JAVADOC_AUTOBRIEF= YES so the solution is either to set it to = NO or escape the dot like .\ (notice the trailing whitespace). In both cases the version number becomes "1 . 12" which is ugly and I think there is no solution to inserted whitespace since I found the unresolved doxygen/doxygen#6154 bug report.

If you have any ideas for a nice display do tell me. PR ready soon-ish, I'm homogenizing deprecation warnings as well while at it.

EDIT: an example of the current message as well because why not:

example

@taketwo
Copy link
Member

taketwo commented Apr 11, 2020

version number becomes "1 . 12" which is ugly and I think there is no solution

Think outside of the box! This can be fixed with a single sed invocation :)

@kunaltyagi
Copy link
Member Author

outside the box

We can use 1_1 instead of 1.1 😆 . Too outside?

@aPonza
Copy link
Contributor

aPonza commented Apr 11, 2020

which is ugly

I mean...this was the argument for needing the point in the first place so...I guess...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: bug Type of issue kind: todo Type of issue module: ci
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants