Skip to content

doc: refresh the doxygen EXCLUDE list - #6506

Open
ump45nose wants to merge 1 commit into
PointCloudLibrary:masterfrom
ump45nose:fix-doxyfile-exclude
Open

ump45nose wants to merge 1 commit into
PointCloudLibrary:masterfrom
ump45nose:fix-doxyfile-exclude

Conversation

@ump45nose

Copy link
Copy Markdown
Contributor

Problem

doc/doxygen/doxyfile.in is outdated (issue #2666): 7 of the 13 EXCLUDE paths no longer exist:

  • @PCL_SOURCE_DIR@/3rdparty (top level, moved long ago)
  • @PCL_SOURCE_DIR@/android
  • @PCL_SOURCE_DIR@/surface/include/pcl/surface/poisson and .../impl/poisson
  • @PCL_SOURCE_DIR@/surface/include/pcl/surface/openNURBS and .../impl/nurbs
  • @PCL_SOURCE_DIR@/test/gtest-1.6.0 (the test/ dir itself is already excluded)

Because INPUT recursively parses the whole source tree, the vendored 3rd-party headers that now live in surface/include/pcl/surface/3rdparty/ (opennurbs/, poisson4/) and recognition/include/pcl/recognition/3rdparty/ (metslib/) are being parsed and documented: the published annotated list at pointclouds.org currently includes internal classes such as pcl::poisson::SparseMatrix, pcl::poisson::OctNode and pcl::poisson::Allocator.

Fix

  • Drop the 7 dead paths.
  • Add the two real 3rd-party header directories to EXCLUDE.
  • Keep the still-valid entries (cmake, test, apps, tools, surface/include/pcl/surface/on_nurbs, simulation).

Fixes #2666

Testing

  • Verified every removed path is missing and every kept/added path exists on current master.
  • Docs-configuration change only; no code affected.

Seven of the thirteen EXCLUDE paths no longer exist (top-level
3rdparty, android, the old poisson/openNURBS/nurbs surface locations
and test/gtest-1.6.0), so doxygen has been parsing the vendored
3rd-party headers that moved to
surface/include/pcl/surface/3rdparty (opennurbs, poisson4) and
recognition/include/pcl/recognition/3rdparty (metslib) - they leak
into the published annotated class list. Exclude the real 3rd-party
directories and drop the dead paths.

Fixes PointCloudLibrary#2666

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doygen file is outdated

1 participant