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 source file name path stripping in Doxygen #2714

Merged

Conversation

taketwo
Copy link
Member

@taketwo taketwo commented Dec 14, 2018

Currently the STRIP_FROM_PATH option is not set, as a result the full path of source files is "leaked" into the generated HTML. For example, this documentation page has the following title:

<title>Point Cloud Library (PCL): /__w/1/s/filters/include/pcl/filters/voxel_grid_occlusion_estimation.h Source File</title>

This is an absolute path on Azure Pipelines worker.

We already have path stripping set up properly in STRIP_FROM_INC_PATH, so this commit just copies the same paths over.

Additionally indentation is fixed in the generated Doxyfile by using spaces instead of tabs.

Currently the STRIP_FROM_PATH option is not set, as a result the full
path of source files is "leaked" into the generated HTML. For example,
this documentation page:

http://docs.pointclouds.org/1.9.1/voxel__grid__occlusion__estimation_8h_source.html

Has the following title:

<title>Point Cloud Library (PCL): /__w/1/s/filters/include/pcl/filters/voxel_grid_occlusion_estimation.h Source File</title>

This is an absolute path on Azure Pipelines worker.

We already have path stripping set up properly in STRIP_FROM_INC_PATH,
so this commit just copies the same paths over.

Additionally indentation is fixed in the generated Doxyfile by using
spaces instead of tabs.
@SergioRAgostinho SergioRAgostinho force-pushed the fix-doxygen-path-stripping branch from 391ecb7 to 35b339e Compare January 7, 2019 20:33
@taketwo taketwo merged commit 74a1ff7 into PointCloudLibrary:master Jan 8, 2019
@taketwo taketwo deleted the fix-doxygen-path-stripping branch January 8, 2019 08:40
@SergioRAgostinho
Copy link
Member

Just to report that the problem still persists.

@taketwo
Copy link
Member Author

taketwo commented Jan 9, 2019

Sorry the link I posted is misleading. It points to 1.9.1 release page, and it's not gonna change of course. The trunk documentation is fixed, as may be observed here: http://docs.pointclouds.org/trunk/voxel__grid__occlusion__estimation_8h_source.html.

@SergioRAgostinho
Copy link
Member

I actually was looking into the trunk version. Maybe, the page was cached. Glad all is well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants