Project

General

Profile

Support #17794

Make Doxygen show full paths for header #include directives

Added by Gianluca Petrillo over 3 years ago. Updated over 3 years ago.

Status:
Assigned
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
-
Start date:
09/28/2017
Due date:
% Done:

0%

Estimated time:
Experiment:
-
Co-Assignees:
Duration:

Description

By default, Doxygen strips the whole path of the header file when showing an #include directive, like in http://nusoft.fnal.gov/larsoft/doxsvn/html/classrecob_1_1Track.html (which on v06_51_00 documentation shows #include "Track.h").

With the proper setting of STRIP_FROM_INC_PATH configuration option, including all relevant include paths, it should be possible to have that like look like #include "lardataobj/RecoBase/Track.h", showing the exact directive required in the actual source code.

History

#1 Updated by Lynn Garren over 3 years ago

  • Status changed from New to Assigned
  • Assignee set to Lynn Garren

We need to understand what the proper setting of STRIP_FROM_INC_PATH would be. It may be a non-trivial problem.

Also available in: Atom PDF