Browse Source

* Generate a PDF documentation instead of the PostScript one. It has nice

hyperlinks! Also, set compact LaTeX mode and a few other Doxygen options.
tags/v0.99.beta14
Sam Hocevar sam 19 years ago
parent
commit
16974a904a
3 changed files with 12 additions and 16 deletions
  1. +1
    -1
      configure.ac
  2. +6
    -6
      doc/Makefile.am
  3. +5
    -9
      doc/doxygen.cfg.in

+ 1
- 1
configure.ac View File

@@ -275,7 +275,7 @@ if test "${enable_doc}" != "no"; then
fi

# Build LaTeX documentation?
AC_PATH_PROG(LATEX, latex, no)
AC_PATH_PROG(LATEX, pdflatex, no)
AC_PATH_PROG(DVIPS, dvips, no)
if test "${DVIPS}" = "no"; then
LATEX="no"


+ 6
- 6
doc/Makefile.am View File

@@ -8,13 +8,13 @@ if BUILD_DOCUMENTATION
htmldoc_DATA = html/doxygen.css
htmldocdir = $(datadir)/doc/libcaca-dev/html
if USE_LATEX
psdoc_DATA = latex/libcaca.ps
psdocdir = $(datadir)/doc/libcaca-dev/ps
pdfdoc_DATA = latex/libcaca.pdf
pdfdocdir = $(datadir)/doc/libcaca-dev/pdf
endif
endif

html/doxygen.css html/doxygen.png: stamp-doxygen
latex/libcaca.ps: stamp-latex
latex/libcaca.pdf: stamp-latex

stamp-doxygen:
if BUILD_DOCUMENTATION
@@ -25,11 +25,11 @@ endif
stamp-latex: stamp-doxygen
if BUILD_DOCUMENTATION
if USE_LATEX
rm -f latex/libcaca.tex latex/libcaca.ps
rm -f latex/libcaca.tex latex/libcaca.pdf
mv latex/refman.tex latex/libcaca.tex
sed 's/setlength{/renewcommand{/' latex/libcaca.tex > latex/refman.tex
cd latex && $(MAKE) $(AM_CFLAGS) ps
mv latex/refman.ps latex/libcaca.ps
cd latex && $(MAKE) $(AM_CFLAGS) refman.pdf
mv latex/refman.pdf latex/libcaca.pdf
touch stamp-latex
endif
endif


+ 5
- 9
doc/doxygen.cfg.in View File

@@ -764,7 +764,7 @@ MAKEINDEX_CMD_NAME = makeindex
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.

COMPACT_LATEX = NO
COMPACT_LATEX = YES

# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
@@ -789,20 +789,20 @@ 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
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE = NO
LATEX_BATCHMODE = YES

# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
@@ -1009,11 +1009,7 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.

PREDEFINED = _DOXYGEN_SKIP_ME \
USE_X11 \
USE_CONIO \
USE_NCURSES \
USE_SLANG
PREDEFINED = _DOXYGEN_SKIP_ME

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.


Loading…
Cancel
Save