Mercurial > hg > octave-nkf

annotate doc/doxyhtml/README @ 16246:98d8d1f4b7f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
build: Add creation of Doxygen docs to build system * configure.ac: Add doc/doxyhtml/Makefile to list of Makefiles to generate. * Doxyfile: Moved and renamed to doc/doxyhtml/Doxygen.cfg. * doc/Makefile.am: Add doxyhtml directory to list of SUBDIRS. * doc/doxyhtml/Doxygen.cfg: Renamed from Doxyfile at top-level. * doc/doxyhtml/Makefile.am: New Makefile.am with rules for building and cleaning Doxygen documentation * doc/doxyhtml/README: README file explaining how to build optional Doxygen documentation.
author Rik <rik@octave.org>
date Mon, 11 Mar 2013 10:49:44 -0700
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16246
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
1 This directory contains documentation in Doxygen format for
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
2 Octave's source code. It is not created by default.
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
3
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
4 To produce Doxygen documentation use
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
5
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
6 make doxyhtml
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
7
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
8 Doxygen documentation can be helpful for developers of Octave, but is not
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
9 needed by users of Octave. In addition, the documentation requires
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
10 approximately 1.2GB of storage space. For these reasons it is not maintained
98d8d1f4b7f8 build: Add creation of Doxygen docs to build system
Rik <rik@octave.org>
parents:
diff changeset
11 under version control nor distributed in tarballs.