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

Fix PCL_DEPRECATED usage in doxygen for a proper Deprecation List in documentation #3905

Merged
merged 1 commit into from
Apr 16, 2020

Conversation

aPonza
Copy link
Contributor

@aPonza aPonza commented Apr 11, 2020

Close #3825

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.

from #3825 (comment)

I also added a sed invocation to deal with the whitespace, thanks Sergey.

Copy link
Member

@kunaltyagi kunaltyagi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is 3 PRs:

  • Change for the title (sed, doxygen, etc.)
  • Using the macro instead of warning/doxygen
  • Changes in pcl_visualizer.cpp

@aPonza
Copy link
Contributor Author

aPonza commented Apr 11, 2020

The commits' names aren't sufficient to address the related-but-different scopes here? I'll split this up, sure.

I've had this for 3 iterations now, though (link):

Scanning dependencies of target test_organized_search
[ 45%] Building CXX object test/search/CMakeFiles/test_organized_search.dir/test_organized.cpp.o
/Users/runner/runners/2.165.2/work/1/s/visualization/src/pcl_visualizer.cpp:1936:1: error: 'deprecated' attribute cannot be applied to types
PCL_DEPRECATED(1, 12, "pcl::visualization::PCLVisualizer::updateCamera is deprecated, just re-rendering all scenes now.")
^
/Users/runner/runners/2.165.2/work/1/s/common/include/pcl/pcl_macros.h:122:17: note: expanded from macro 'PCL_DEPRECATED'
                PCL_DEPRECATED_MINOR(Minor,                             \
                ^
/Users/runner/runners/2.165.2/work/1/s/common/include/pcl/pcl_macros.h:108:17: note: expanded from macro 'PCL_DEPRECATED_MINOR'
                PCL_DEPRECATED_IMPL(Msg),           \
                ^
/Users/runner/runners/2.165.2/work/1/s/common/include/pcl/pcl_macros.h:89:42: note: expanded from macro 'PCL_DEPRECATED_IMPL'
  #define PCL_DEPRECATED_IMPL(message) [[deprecated(message)]]
                                         ^

Why doesn't it like the macro? I'll think about it in the morning.

@aPonza aPonza changed the title Fix PCL_DEPRECATED usage in doxygen and in the codebase Fix PCL_DEPRECATED usage in doxygen for a proper Deprecation List in documentation Apr 15, 2020
@aPonza aPonza marked this pull request as ready for review April 15, 2020 18:18
@aPonza
Copy link
Contributor Author

aPonza commented Apr 15, 2020

I stashed the changes in visualizer as they'll most likely come around again while clang-doxy-ing [visualization]

@kunaltyagi kunaltyagi added changelog: fix Meta-information for changelog generation module: docs needs: code review Specify why not closed/merged yet labels Apr 16, 2020
@SergioRAgostinho SergioRAgostinho merged commit f8f6466 into PointCloudLibrary:master Apr 16, 2020
@aPonza aPonza deleted the deprecated branch April 16, 2020 07:50
@taketwo taketwo changed the title Fix PCL_DEPRECATED usage in doxygen for a proper Deprecation List in documentation Fix PCL_DEPRECATED usage in doxygen for a proper Deprecation List in documentation May 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: fix Meta-information for changelog generation module: docs needs: code review Specify why not closed/merged yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CI] The deprecation list is showing weird things
3 participants