Skip to content

Commit

Permalink
Add development version of doxygen configuration
Browse files Browse the repository at this point in the history
New target: doc/doxygen-devel

Create a new development version of doxygen configuration, which creates a more
verbose doxygen reference including functions and files not exposed to API and
their call graph. Call graphs require graphviz installed.
  • Loading branch information
ozars committed Aug 21, 2018
1 parent 060c50b commit 8294dc8
Show file tree
Hide file tree
Showing 5 changed files with 1,808 additions and 0 deletions.
8 changes: 8 additions & 0 deletions HACKING
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ are three-fold:

3) it reduces the number of decisions that must be made

Doxygen Reference for Development
================

You can use `doc/doxygen-devel` target to generate a verbose doxygen reference.
Resulting documentation will be placed into `doc/doxygen-devel`. This option
needs graphviz installed to render call graphs. If graphviz is not found they
won't be rendered.

Release Process
===============

Expand Down
3 changes: 3 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ doc/check_html:
doc/doxygen:
$(MAKE) -C doc doxygen

doc/doxygen-devel:
$(MAKE) -C doc doxygen-devel

# check we can do a clean build, including docs.
# perhaps we should check for out of date (svn st -u) and modified files.
prereleasecheck: doc/check_html doc/doxygen
Expand Down
6 changes: 6 additions & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,12 @@ fi

AM_CONDITIONAL(USE_FILTERDIFF, [test x"$FILTERDIFF" = x"filterdiff"])

AC_CHECK_PROGS(GRAPHVIZ, dot, false)
# If graphviz doesn't exist 'make doc/doxygen-devel' will skip rendering graphs
# and inform the developer about it. This target is optional and it aims
# developers of libcheck, not users.
AM_CONDITIONAL(USE_GRAPHVIZ, [test x"$GRAPHVIZ" = x"dot"])

# Checks for pthread implementation.
ACX_PTHREAD
CC="$PTHREAD_CC"
Expand Down
10 changes: 10 additions & 0 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ check_html: $(srcdir)/check.texi
doxygen:
doxygen $(srcdir)/doxygen.conf

## if graphviz does not exist disable graph generation
if USE_GRAPHVIZ
doxygen-devel:
doxygen $(srcdir)/doxygen-devel.conf
else
doxygen-devel:
( cat $(srcdir)/doxygen-devel.conf; echo "HAVE_DOT = NO" ) | doxygen -
@ >&2 echo "graphviz not found, graphs will not be rendered."
endif

## we need to include several diffs as we evolve the example in the
## tutorial. this means we'll generate them from the example source.

Expand Down
Loading

0 comments on commit 8294dc8

Please sign in to comment.