diff options
| author | Ralph Giles <giles@mozilla.com> | 2011-09-07 10:18:00 +0400 |
|---|---|---|
| committer | Ralph Giles <giles@mozilla.com> | 2011-09-07 22:06:23 +0400 |
| commit | 35d4fb78eafc6aa738919a8c4984744e1bcf52d9 (patch) | |
| tree | 2e4eda352abb98434356c9ddedb4bcc10a830894 /doc/Makefile.am | |
| parent | ee931fcd25f9d715e35d033cd96eedd90ed45e39 (diff) | |
Add initial Doxygen support for generating api documentation.
Doxygen is a tool for generating programming documentation
based on comments in header and source files. This commit
adds the necessary configuration file and associated support
in the autotools build.
Right now it doesn't generate much documentation because our
public header files aren't marked up. Warnings are printed
for undocumented members and arguments.
Diffstat (limited to 'doc/Makefile.am')
| -rw-r--r-- | doc/Makefile.am | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 00000000..7e72e114 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,20 @@ +## Process this file with automake to produce Makefile.in + +DOCINPUTS = $(top_srcdir)/src/opus.h \ + $(top_srcdir)/src/opus_multistream.h \ + $(top_srcdir)/libcelt/opus_defines.h \ + $(top_srcdir)/libcelt/opus_types.h + +doc_DATA = doxygen-build.stamp + +EXTRA_DIST = Doxyfile.in + +if HAVE_DOXYGEN +doxygen-build.stamp: Doxyfile $(DOCINPUTS) + doxygen + touch $@ +else +doxygen-build.stamp: Doxyfile $(DOCINPUTS) + @echo "*** Warning: Doxygen not found; API documentation will not be built." + touch $@ +endif |