]> granicus.if.org Git - libevent/commitdiff
Generate only real man pages with doxygen (MAN_LINKS=NO)
authorAzat Khuzhin <azat@libevent.org>
Wed, 16 Sep 2020 05:10:11 +0000 (08:10 +0300)
committerAzat Khuzhin <azat@libevent.org>
Wed, 16 Sep 2020 05:27:10 +0000 (08:27 +0300)
WIth MAN_LINKS=YES doxygen will generate ton's of man pages for each
field, function and so on, but it will not contain anything useful
except for link to another man page (header).

So to avoid man pages clashing, disable MAN_LINKS, and this will
generate man pages only for explicitly documented parts.

But even after this we have pretty non-unique man pages names:

    $ find install/ -name '*.3'
    install/share/man/man3/util.h.3
    ...

Looks like we should add prefix for each of them...
But let's see if there will be a problem.

Fixes: #1097
Doxyfile

index aef64c55d962f8336400b262ec09929779643bab..486ab66900be1f5e81d8f56dcce57d50175cfb96 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -189,7 +189,7 @@ MAN_EXTENSION          = .3
 # only source the real man page, but without them the man command 
 # would be unable to find the correct page. The default is NO.
 
-MAN_LINKS              = YES
+MAN_LINKS              = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor