About JACK
- -m4_include(`trailer.html') diff --git a/doc/intro.m4 b/doc/intro.m4 deleted file mode 100644 index c1525b3..0000000 --- a/doc/intro.m4 +++ /dev/null @@ -1,4 +0,0 @@ - - -m4_include(`header.html') -m4_include(`trailer.html') diff --git a/doc/issues.m4 b/doc/issues.m4 deleted file mode 100644 index c4080d4..0000000 --- a/doc/issues.m4 +++ /dev/null @@ -1,85 +0,0 @@ - - -m4_include(`header.html') - -Issues to consider when porting programs to JACK
- -Sample bit width assumptions
- -A lot existing Linux audio software tends to assume that audio samples -are 8 or 16 bits wide, and usesshort to store them. This
-does not work with JACK, where all sample data, regardless of the
-original data format in which it was obtained (e.g. from disk), is
-stored as a floating point value normalized to the range -1.0 to +1.0.
-
-Channel interleaving assumptions
- -Almost all existing Linux audio software assumes that when delivering -a sample stream with more than one channel, the samples should be -interleaved. This does not work with JACK, where all sample streams -are mono. - -Block-on-write or block-on-read assumptions
- -Quite a lot of existing Linux audio software tends to be structured -around the blocking behaviour of a call to write(2) or read(2) when -the file descriptor concerned refers to the audio interface. They -often have this structure: - -process() callback which does this:
-
-process() function should not under
-(almost) any circumstances block: that is, it may not read/write data
-from/to a file, it may not call malloc(), it may not use
-pthread_mutex_lock(), and it should generally avoid system calls. the
-process() callback will be executed when the JACK server
-decides it should be, and it cannot be used to time other parts of the
-program.
-
-m4_include(`trailer.html')
-
diff --git a/doc/links.m4 b/doc/links.m4
deleted file mode 100644
index c1525b3..0000000
--- a/doc/links.m4
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-m4_include(`header.html')
-m4_include(`trailer.html')
diff --git a/doc/mailinglist.m4 b/doc/mailinglist.m4
deleted file mode 100644
index c1525b3..0000000
--- a/doc/mailinglist.m4
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-m4_include(`header.html')
-m4_include(`trailer.html')
diff --git a/doc/manual.m4 b/doc/manual.m4
deleted file mode 100644
index c1525b3..0000000
--- a/doc/manual.m4
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-m4_include(`header.html')
-m4_include(`trailer.html')
diff --git a/doc/news.m4 b/doc/news.m4
deleted file mode 100644
index c1525b3..0000000
--- a/doc/news.m4
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-m4_include(`header.html')
-m4_include(`trailer.html')
diff --git a/jack.dox b/doc/reference.doxygen.in
similarity index 99%
rename from jack.dox
rename to doc/reference.doxygen.in
index 62cb50c..5626d2c 100644
--- a/jack.dox
+++ b/doc/reference.doxygen.in
@@ -23,7 +23,7 @@ PROJECT_NAME = Jack
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 0.20.5
+PROJECT_NUMBER = @JACK_VERSION@
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
@@ -301,7 +301,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = jack/jack.h
+INPUT = @top_srcdir@/jack/jack.h
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -567,13 +567,13 @@ LATEX_HEADER =
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
-PDF_HYPERLINKS = NO
+PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
-USE_PDFLATEX = NO
+USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
@@ -779,7 +779,7 @@ PERL_PATH = /usr/bin/perl
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
# recommended to install and use dot, since it yield more powerful graphs.
-CLASS_DIAGRAMS = YES
+CLASS_DIAGRAMS = NO
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
diff --git a/doc/requirements.m4 b/doc/requirements.m4
deleted file mode 100644
index c1525b3..0000000
--- a/doc/requirements.m4
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-m4_include(`header.html')
-m4_include(`trailer.html')
diff --git a/doc/todo.m4 b/doc/todo.m4
deleted file mode 100644
index c1525b3..0000000
--- a/doc/todo.m4
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-m4_include(`header.html')
-m4_include(`trailer.html')
diff --git a/doc/trailer.html b/doc/trailer.html
deleted file mode 100644
index f447800..0000000
--- a/doc/trailer.html
+++ /dev/null
@@ -1,23 +0,0 @@
-
-
-
-
-
-
-Last modified: @LASTMOD@ by @USER@
-
[Best Viewed with Any Browser]
-
-
