Commit graph

12 commits

Author SHA1 Message Date
Ron
3e6691a703 Don't repeatedly install the doc dir for every file 2013-05-12 14:32:52 +09:30
Hanspeter Niederstrasser
ca82894ef1 remove GNUism from install doc command 2012-10-07 10:33:28 -04:00
Ralph Giles
0e232490d8 Only install opus_*.3 manpages. Fixes 'make distcheck'.
We were installing every readable file in man/man3, but
only unstalling files matching opus_*.3. Some doxygen
versions construct manpage versions of the marked up
header files and directory index, which got left on the
system after 'make uninstall'.

I don't think the 'uninstall' target is widely used, it's
often broken and can easily break other software. However,
we rely on 'make distcheck' which does verify this issue.

Instead, only install the opus_*.3 manpages, which are the
core api documentation.
2012-08-10 14:42:00 -07:00
Ron
9a89d56d46 Include the doc dir in DIST_SUBDIRS instead of EXTRA_DIST
And explicitly specify what we want included in EXTRA_DIST of doc/Makefile.am,
otherwise make dist picks up whatever random junk you might have laying around
in that dir at the time you run it.

Tweak the top level delegation targets, because this means distclean will be
run in the doc dir by default now without our help.
2012-06-11 15:33:57 -04:00
Ron
783ecbff0c Don't bark scary warnings at compile time about no doxygen
We already report whether or not the docs will be built in the summary box
at the end of the configure run.
2012-06-11 14:24:18 -04:00
Gregory Maxwell
91b56f6542 Fixup paths in doc/ 2012-06-11 13:33:35 -04:00
Gregory Maxwell
1f65ce89b0 Correct documentation in opus_custom.h. 2012-06-10 21:15:02 -04:00
Ron
b2b0391e56 Actually install the documentation with make install
Instead of just its build stamp :)
2012-05-21 23:14:50 +09:30
Jean-Marc Valin
4923f3f80e Moves the main headers from src/ to include/ 2011-10-26 21:36:57 -04:00
Jean-Marc Valin
c37499090b renames the libcelt/ directory to celt/ 2011-09-13 18:21:18 -07:00
Ralph Giles
09767575a5 Tell automake to clean the doxygen output.
Without the extra clean, 'make distcheck' fails because
the distclean target doesn't remove all generated files.
2011-09-07 11:18:23 -07:00
Ralph Giles
35d4fb78ea 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.
2011-09-07 11:06:23 -07:00