16 Commits

Author SHA1 Message Date
Azat Khuzhin
9b270c5e02 Generate only real man pages with doxygen (MAN_LINKS=NO)
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
2020-09-16 08:27:10 +03:00
yuangongji
620a3fa1d5 Doxygen documentation improvements
- Documentation for `bufferevent_compat.h` and `rpc.h` is not generated
  since the `@file` command is missing. It can be fixed by adding
  `@file` in file comment block.
- The briefs of buffer.h,bufferevent.h and some other files are missing.
  Adding `@brief` command can fix it.
- The parameters in the function declaration are different from the
  parameters following the `@param` command.We should change them to the
  same.
- Documentation of `watch.h` is not generated since `watch.h` has not
  been added to the Doxyfile `INPUT` tag.

- Add link to the watch.h in event.h
2019-08-29 23:08:12 +03:00
yuangongji
f9c6a14ee0 autotools: attach doxygen target into all target
v2: disable man pages by default
2019-08-28 01:23:26 +03:00
Nick Mathewson
da455e92f5 Fix doxygen to use new macro conventions 2012-02-29 15:48:59 -05:00
Nick Mathewson
aea0555b76 Update Doxyfile to produce more useful output 2011-07-05 13:01:31 -04:00
Nick Mathewson
2888faccd1 Revise the event/evbuffer/bufferevent doxygen for clarity and accuracy 2011-07-05 13:01:07 -04:00
Niels Provos
a146af1db8 move more code directly into evrpc.c; provide backwards compatible vararg macros
svn:r1244
2009-04-25 00:15:55 +00:00
Niels Provos
bbf79707f9 refactor evrpc.h header filer
svn:r1241
2009-04-25 00:14:58 +00:00
Niels Provos
f00f0c2533 make doxygen happier
svn:r1199
2009-04-18 04:34:45 +00:00
Niels Provos
49f4c0ef88 generate documentation for move dns header files
svn:r979
2008-12-25 16:21:13 +00:00
Niels Provos
de1c43926b migrate evhttp to event2; accessors are still missing
svn:r790
2008-05-08 06:15:04 +00:00
Niels Provos
28add6b9e2 add more header files to doxygen
svn:r747
2008-04-29 23:18:04 +00:00
Niels Provos
0c49e456f1 document thread functions
svn:r688
2008-03-04 05:42:20 +00:00
Niels Provos
5c70ea4c9d improved code for evbuffer; avoids memcpy
svn:r674
2008-02-28 02:47:43 +00:00
Niels Provos
dc2317f921 improve doxygen documentation
svn:r473
2007-11-04 06:35:29 +00:00
Nick Mathewson
7135ffb6fc r15096@catbus: nickm | 2007-09-18 11:02:12 -0400
Add Doxygen documentation to header files; patch from Mark Heily.


svn:r436
2007-09-18 15:12:09 +00:00