[Openvpn-devel,1/2] doxygen: use relative paths from the project root

Message ID 1509540912-8739-1-git-send-email-steffan.karger@fox-it.com
State Changes Requested
Delegated to: Steffan Karger
Headers show
Series
  • [Openvpn-devel,1/2] doxygen: use relative paths from the project root
Related show

Commit Message

Steffan Karger Nov. 1, 2017, 12:55 p.m.
Instead of genering docs with full path names (e.g.
/home/steffan/dev/openvpn/src/openvpn/crypto.h), use a relative path wrt
the project root (e.g. src/openvpn/crypto.h).  This makes the generated
doxygen easier to read.

Signed-off-by: Steffan Karger <steffan.karger@fox-it.com>
---
 doc/doxygen/openvpn.doxyfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Gert Doering Nov. 8, 2017, 9:48 a.m. | #1
Hi,

On Wed, Nov 01, 2017 at 01:55:11PM +0100, Steffan Karger wrote:
> Instead of genering docs with full path names (e.g.
> /home/steffan/dev/openvpn/src/openvpn/crypto.h), use a relative path wrt
> the project root (e.g. src/openvpn/crypto.h).  This makes the generated
> doxygen easier to read.

Feature-ACK, but since there is a patch 2 in the series that right
afterwards changes this very line 

> -STRIP_FROM_PATH        = ""
> +STRIP_FROM_PATH        = "."

... again, maybe just folding these two patches together makes more sense.

gert

Patch

diff --git a/doc/doxygen/openvpn.doxyfile b/doc/doxygen/openvpn.doxyfile
index a7d9728..80cda2b 100644
--- a/doc/doxygen/openvpn.doxyfile
+++ b/doc/doxygen/openvpn.doxyfile
@@ -25,7 +25,7 @@  ABBREVIATE_BRIEF       = "The $name class" \
 ALWAYS_DETAILED_SEC    = NO
 INLINE_INHERITED_MEMB  = NO
 FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        = ""
+STRIP_FROM_PATH        = "."
 STRIP_FROM_INC_PATH    =
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES # NO