summaryrefslogtreecommitdiffstats
path: root/doc/installdox_usage.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2012-01-10 21:15:46 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2012-01-10 21:15:46 (GMT)
commitfd8b446f8ae60e7d1dc259c6f5fe38c287377d19 (patch)
treeab92980b31825ec310269f7799b1076422132a3e /doc/installdox_usage.doc
parent8a65c23b74c33c38b4d1234e76cec74bd08cea69 (diff)
downloadDoxygen-fd8b446f8ae60e7d1dc259c6f5fe38c287377d19.zip
Doxygen-fd8b446f8ae60e7d1dc259c6f5fe38c287377d19.tar.gz
Doxygen-fd8b446f8ae60e7d1dc259c6f5fe38c287377d19.tar.bz2
Release-1.7.6.1-20120110
Diffstat (limited to 'doc/installdox_usage.doc')
-rw-r--r--doc/installdox_usage.doc59
1 files changed, 0 insertions, 59 deletions
diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc
deleted file mode 100644
index a93ca0a..0000000
--- a/doc/installdox_usage.doc
+++ /dev/null
@@ -1,59 +0,0 @@
-/******************************************************************************
- *
- *
- *
- * Copyright (C) 1997-2011 by Dimitri van Heesch.
- *
- * Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
- * for any purpose. It is provided "as is" without express or implied warranty.
- * See the GNU General Public License for more details.
- *
- * Documents produced by Doxygen are derivative works derived from the
- * input used in their production; they are not affected by this license.
- *
- */
-/*! \page installdox_usage Installdox usage
-
-Installdox is a perl script that is generated by doxygen whenever
-tag files are used (See \c TAGFILES
-in section \ref config_extref). The script is
-located in the same directory where the HTML files are located.
-
-Its purpose is to set the location of the external documentation
-for each tag file at install time.
-
-Calling \c installdox with option <b>-h</b> at the command line
-will give you a brief description of the usage of the program.
-
-The following options are available:
-<dl>
-<dt><b>-l <tt>\<tagfile\>\@\<location\></tt></b><dd>
- Each tag file contains information about the files, classes and members
- documented in a set of HTML files. A user can install these
- HTML files anywhere on his/her hard disk or web site.
- Therefore installdox \e requires the location of the
- documentation for each tag file <tt>\<tagfile\></tt>
- that is used by doxygen. The location <tt>\<location\></tt> can be
- an absolute path or a URL.
-
- \par Note:
- Each \<tagfile\> must be unique and should only be the name of the
- file, not including the path.
-
-<dt><b>-q</b><dd>
- When this option is specified, installdox will generate no output other
- than fatal errors.
-</dl>
-Optionally a list of HTML files may be given.
-These files are scanned and modified if needed.
-If this list is omitted all files in the current directory
-that end with \c .html are used.
-
-The \c installdox script is unique for each generated class browser
-in the sense that it `knows' what tag files are used. It will generate an error if
-the <b>-l</b> option is missing for a tag file or if an invalid tag file
-is given.
-
-*/