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

[Gert Doering]

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


-- 
USENET is *not* the non-clickable part of WWW!
   //www.muc.de/~gert/
Gert Doering - Munich, Germany g...@greenie.muc.de
fax: +49-89-35655025g...@net.informatik.tu-muenchen.de


signature.asc
Description: PGP signature
--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot___
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

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

[Steffan Karger]

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 
---
 doc/doxygen/openvpn.doxyfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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
-- 
2.7.4


--
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
___
Openvpn-devel mailing list
Openvpn-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/openvpn-devel