Commit Graph

36 Commits

Author SHA1 Message Date
Taylor Yu
69d56625d1 Doxyfile: skip CHECK_PRINTF()
Part of ticket 30984.
2019-12-08 22:40:00 -06:00
Nick Mathewson
625ad65382 Doxygen: expect .md files, not .dox files
Also, I have to add src/rust/registry to the excluded paths, since
it includes .md files that Doxygen can't handle.
2019-11-15 09:23:10 -05:00
Nick Mathewson
108d2967a7 Process "dox" files as regular markdown. 2019-11-15 09:20:51 -05:00
Nick Mathewson
97b5ff2b1d Merge branch 'ticket32211' 2019-11-15 09:10:11 -05:00
Nick Mathewson
2b3dc3384c Merge branch 'ticket32385' 2019-11-11 10:38:10 -05:00
George Kadianakis
8344776224 Merge branch 'tor-github/pr/1504' 2019-11-11 14:47:33 +02:00
Nick Mathewson
baddb30889 doxygen: add a command for linking to our bugtracker 2019-11-10 15:49:45 -05:00
Nick Mathewson
5914addcbc Teach doxygen about option-declaration code.
These settings allow doxygen to find and understand doxygen comments
in configuration definitions made using the macros in confdecl.h.
2019-11-07 07:28:43 -05:00
Nick Mathewson
d7872b775d Doxygen: provide a style sheet
This sheet tries to make links to the source code browser less obtrusive.
2019-11-05 13:50:01 -05:00
Nick Mathewson
bd6bd7d28e Doxygen: enable source code browser 2019-11-05 12:52:28 -05:00
Nick Mathewson
de4ffebcf0 Doxygen: set HIDE_SCOPE_NAMES.
This option tells doxygen to describe a member "member" of a struct
"container" as "member", not "container::member".   C doesn't use
the :: syntax, so this should help us with readability.
2019-11-05 12:43:38 -05:00
Nick Mathewson
36bceacdcd Doxygen: set TYPEDEF_HIDES_STRUCT.
This option tells doxygen to handle typedef struct foo_t foo_t by
making foo_t and struct foo_t synonymous. This lets doxygen find
documentation that it would otherwise miss: otherwise, if it sees
documentation for "int func(foo_t *)" and a prototype for
"int func(struct foo_t)", it will think that the prototype is
undocumented.

Part of #32386.
2019-11-05 12:43:21 -05:00
Nick Mathewson
d3e547b2bd Re-think our doxygen warnings wrt missing docs and fatalness.
Up till now, we have warned about all missing documentation, which
meant that we could never make doxygen warnings fatal.  This has led
to our doxygen output getting full of errors several times in the
past.

This commit changes our approach to doxygen warnings: missing
documentation warnings are only on when the user asks for them with
--enable-missing-doc-warnings.  When that option is not present,
doxygen respects the --enable-fatal-warnings flag.

Closes ticket 32385.
2019-11-05 12:24:02 -05:00
Nick Mathewson
6c4479a90e Remove a dot from ALIASES declaration. 2019-11-05 09:02:59 -05:00
Nick Mathewson
c01f624f4a Another attempt to fix Doxygen references in out-of-tree builds
This time, we're using cd to run doxygen from inside the source
directory, not the build directory at all.  This lets us call the
source directory ".", which (I hope) both Doxygen 1.8.13 and 1.8.15
will understand.

Naturally, this requires a corresponding change in the doxygen
configuration so that we are directing the output to the correct
place.

Fix for 32378.
2019-11-05 08:57:39 -05:00
Nick Mathewson
fa860b6b17 Revert "doxygen: Use @SRCDIR@ instead of @top_srcdir@."
This reverts commit 4c2c98900b.
2019-11-05 08:49:48 -05:00
Nick Mathewson
4c2c98900b doxygen: Use @SRCDIR@ instead of @top_srcdir@.
Our @top_srcdir@ directory can contain "..", which confuses doxygen
when it tries to make references to directories.  Using
@abs_top_srcdir@ has the same problem.  Instead, we should use our
@SRCDIR@ configuration variable, which is canonicalized.
2019-11-05 08:37:22 -05:00
Nick Mathewson
9b13191192 Doxygen: use \refdir everywhere.
This commit was generated with:

find src -name '*.dox' |xargs perl -i -pe 's{\\ref src/(\S+) \"\S+}{\\refdir{$1}};'
2019-11-04 11:12:27 -05:00
Nick Mathewson
b95bc4d839 Doxygen: define an alias for linking to a directory.
We need to use this kind of trickery to make directory links work in
out-of-tree builds.
2019-11-04 11:08:04 -05:00
Nick Mathewson
e2da29e045 Doxygen: Better path handling.
This change tells doxygen to include all files not explicitly
excluded, and to document paths along with filenames.
2019-11-03 15:00:14 -05:00
Nick Mathewson
7ec314a67f Doxygen: accept .dox as pure doxygen, and interpret everything as C 2019-11-03 12:16:36 -05:00
Nick Mathewson
7824a65aa0 Doxyfile.in: switch to a tor-style green color scheme. 2019-11-01 09:23:10 -04:00
Nick Mathewson
85accdf00a Tell doxygen not to pay attention to __attribute__. 2019-10-16 11:02:49 -04:00
Nick Mathewson
2329f8a28c Teach Doxygen to handle MOCK_{DECL,IMPL} 2019-10-16 10:59:29 -04:00
Nick Mathewson
593acfabb3 Doxygen: stop producing LaTeX.
Running doxygen with latex gave us all manner of unicode issues,
slowed down the "make doxygen" target by a lot, and added several
latex dependencies... all to produce a 4000-page reference manual
which is probably not what anybody wanted.

Closes ticket 32099.
2019-10-16 09:56:31 -04:00
Nick Mathewson
033d76b0e0 Doxygen: update doxyfile to a more recent version.
I have left the settings at their old values, except when they
referred to nonexistent files.

Closes ticket 32110
2019-10-16 09:07:21 -04:00
Taylor Yu
763ccd0928 Fix Doxyfile for 0.3.5 source tree moves
Make Doxygen work again after the 0.3.5 source tree moves.  Fixes bug
28435; bugfix on 0.3.5.1-alpha.
2018-11-14 07:45:55 -05:00
Nick Mathewson
f720a5a439 Fix everything that previously referred to src/or 2018-07-05 17:15:50 -04:00
Nick Mathewson
ed9845550e doxygen says these options are obsolete 2016-10-24 10:31:05 -04:00
cypherpunks
17cbc4350f Use output variables instead of relative paths.
Fixes the following rules in out-of-tree builds;
- check-spaces
- check-docs
- check-logs
- Doxygen
- coverage-html

And cleans up additional directories;
- coverage_html
- doc/doxygen
2015-03-14 13:00:04 -04:00
Nick Mathewson
7f6af7a602 Fix up all doxygen warnings other than "foo is not documented" 2011-03-16 14:47:27 -04:00
Nick Mathewson
2def9e0a6e Turn on the "source browser" feature for our generated HTML. 2011-03-16 14:36:42 -04:00
Nick Mathewson
57e23fc9a5 Run "doxygen -u" to update doxygen config file. 2011-03-16 14:34:59 -04:00
Sebastian Hahn
d230827912 Remove all svn metadata minus what I missed.
Tor doesn't use SVN anymore, making $Revision$, $Id$ and $Date$
meaningless. Remove them without replacement.
2009-05-05 17:05:46 +02:00
Peter Palfrader
b14bb2d85c Doxygen whines bitterly unless I let it update the configfile
svn:r11948
2007-10-15 19:05:20 +00:00
Nick Mathewson
5d90e24cfc Make Doxyfile get updated by configure script, so the version number gets set correctly.
svn:r10525
2007-06-07 16:19:17 +00:00