summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:34:06 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:34:06 (GMT)
commitee8333a5d2ecf84deeb5d05ed8b23c212729cdac (patch)
tree43e0b215b5d3d2b436509cbb1cd22102aef61b1d /doc
parent6aa7383e23c850af36c25b87e5737a2e2f635083 (diff)
downloadDoxygen-ee8333a5d2ecf84deeb5d05ed8b23c212729cdac.zip
Doxygen-ee8333a5d2ecf84deeb5d05ed8b23c212729cdac.tar.gz
Doxygen-ee8333a5d2ecf84deeb5d05ed8b23c212729cdac.tar.bz2
mods for doxygen-0.49-990829
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.in (renamed from doc/Makefile)8
-rw-r--r--doc/Makefile.win.in15
-rw-r--r--doc/config.doc93
-rw-r--r--doc/features.doc10
-rw-r--r--doc/index.doc7
-rw-r--r--doc/install.doc10
-rw-r--r--doc/starting.doc23
-rw-r--r--doc/trouble.doc9
8 files changed, 130 insertions, 45 deletions
diff --git a/doc/Makefile b/doc/Makefile.in
index 953517a..f2de956 100644
--- a/doc/Makefile
+++ b/doc/Makefile.in
@@ -1,14 +1,10 @@
-include ../Makefile.config
-
-DOXYDIR=../bin
-DOXYGEN_DOCDIR=..
all: FORCE
- DOXYGEN_DOCDIR=$(DOXYGEN_DOCDIR); \
+ DOXYGEN_DOCDIR=$(DOXYGEN); \
export DOXYGEN_DOCDIR; \
VERSION=$(VERSION) ; \
export VERSION; \
- $(DOXYDIR)/doxygen
+ $(DOXYGEN)/bin/doxygen
@rm -f ../latex/refman.tex
@cp doxygen_logo*.gif ../html
@cp Makefile.latex ../latex/Makefile
diff --git a/doc/Makefile.win.in b/doc/Makefile.win.in
new file mode 100644
index 0000000..e870a81
--- /dev/null
+++ b/doc/Makefile.win.in
@@ -0,0 +1,15 @@
+all: FORCE
+ set DOXYGEN_DOCDIR=file:///$(DOXYGEN)
+ set VERSION=$(VERSION)
+ $(DOXYGEN)\bin\doxygen
+ @del ..\latex\refman.tex
+ @copy doxygen_logo*.gif ..\html
+ @copy Makefile.latex ..\latex\Makefile
+ @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen_manual.tex >..\latex\doxygen_manual.tex
+ @sed -e "s/\$$VERSION/$(VERSION)/g" doxygen.sty >..\latex\doxygen.sty
+ @copy doxygen_logo.eps ..\latex
+
+clean:
+ del /s /q ..\html ..\latex
+
+FORCE:
diff --git a/doc/config.doc b/doc/config.doc
index 2bf3dc7..f238ad1 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -35,7 +35,7 @@ Values are sequences of non-blanks. If the value should contain one or more
blanks it must be surrounded by quotes (&quot;...&quot;).
Multiple lines can be concatenated by inserting a backslash (\\)
as the last character of a line.
-Environment variables can expanded using the pattern \$(ENV_VARIABLE_NAME).
+Environment variables can expanded using the pattern \c $(ENV_VARIABLE_NAME).
The configuration options can be divided into several categories.
Below is a list of tags that are recognized for each category.
@@ -155,7 +155,7 @@ Below is a list of tags that are recognized for each category.
\addindex STRIP_FROM_PATH
If the \c FULL_PATH_NAMES tag is set to \c YES then the \c STRIP_FROM_PATH tag
can be used to strip a user defined part of the path. Stripping is
- only done if the specified string matches the left-hand part of the
+ only done if one of the specified strings matches the left-hand part of the
path.
<dt>\c CLASS_DIAGRAMS <dd>
@@ -164,6 +164,12 @@ Below is a list of tags that are recognized for each category.
generate a class diagram (in Html and LaTeX) for classes with base or
super classes. Setting the tag to \c NO turns the diagrams off.
+<dt>\c SOURCE_BROWSER <dd>
+ \addindex SOURCE_BROWSER
+ If the \c SOURCE_BROWSER tag is set to \c YES than the body of a member or
+ function will be appended as a block of code to the documentation of.
+ that member or function.
+
<dt>\c CASE_SENSE_NAMES <dd>
\addindex CASE_SENSE_NAMES
If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then Doxygen
@@ -179,6 +185,13 @@ Below is a list of tags that are recognized for each category.
which an include is specified. Set to NO to disable this.\n";
\sa Section \ref cmdclass "\\class".
+<dt>\c JAVADOC_AUTOBRIEF <dd>
+ \addinex JAVADOC_AUTOBRIEF
+ If the JAVADOC_NO_AUTOBRIEF is set to YES (the default) then Doxygen
+ will interpret the first line (until the first dot) of a JavaDoc-style
+ comment as the brief description. If set to NO, the Javadoc-style will
+ behave just like the Qt-style comments.
+
</dl>
\subsection config_input Input related options
@@ -226,12 +239,6 @@ Below is a list of tags that are recognized for each category.
directories that contain example code fragments that are included (see
the \\include command in section \ref cmdinclude "\\include").
-<dt>\c INCLUDE_PATH <dd>
- \addindex INCLUDE_PATH
- The INCLUDE_PATH tag can be used to specify one or more directories that
- contain include files that are not input files but should be processed by
- the preprocessor.
-
<dt>\c INPUT_FILTER <dd>
\addindex INPUT_FILTER
The \c INPUT_FILTER tag can be used to specify a program that doxygen should
@@ -298,6 +305,44 @@ Below is a list of tags that are recognized for each category.
Doxygen will replace them by respectively
the title of the page, the current date and time, or only the current date.
+<dt>\c HTML_ALIGN_MEMBERS <dd>
+
+If the \c HTML_ALIGN_MEMBERS tag is set to \c YES, the members of classes,
+files or namespaces will be aligned in HTML using tables. If set to
+NO a bullet list will be used.
+
+\par Notice
+Setting this tag to NO will become obsolete in the future, since I only
+intent to support and test the aligned representation.
+
+<dt>\c GENERATE_HTMLHELP <dd>
+
+If the \c GENERATE_HTMLHELP tag is set to \c YES,
+doxygen generates three additional HTML index files:
+\c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
+project file that can be read by
+<a href="http://msdn.microsoft.com/workshop/author/htmlhelp">
+Microsoft HTML help workshop</a>
+\latexonly
+(see http://msdn.microsoft.com/workshop/author/htmlhelp)
+\endlatexonly
+on Windows.
+
+The HTML workshop contains a compiler that can convert all HTML output
+generated by doxygen into a single compressed HTML file (.chm). Compressed
+HTML files are now used as the Windows 98 help format, and will replace
+the old windows help format (.hlp) on all Windows platforms in the future.
+Compressed HTML files also contain an index, a table of contents,
+and you can search for words in the documentation
+(which basically renders \c doxysearch obsolete on Windows).
+The HTML workshop also contains a viewer for compressed HTML files.
+
+<dt>\c ALPHABETICAL_INDEX <dd>
+
+If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index
+of all compounds will be generated. Enable this if the project contains
+a lot of classes, structs, unions or interfaces.
+
</dl>
\subsection latex_output LaTeX related options
@@ -542,22 +587,22 @@ SEARCH_INCLUDES = YES
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = $(QTDIR)/
PREDEFINED = USE_TEMPLATECLASS Q_EXPORT= \
- QArrayT=QArray \
- QListT=QList \
- QDictT=QDict \
- QQueueT=QQueue \
- QVectorT=QVector \
- QPtrDictT=QPtrDict \
- QIntDictT=QIntDict \
- QStackT=QStack \
- QDictIteratorT=QDictIterator \
- QListIteratorT=QListIterator \
- QCacheT=QCache \
- QCacheIteratorT=QCacheIterator \
- QIntCacheT=QIntCache \
- QIntCacheIteratorT=QIntCacheIterator \
- QIntDictIteratorT=QIntDictIterator \
- QPtrDictIteratorT=QPtrDictIterator
+ QArrayT:=QArray \
+ QListT:=QList \
+ QDictT:=QDict \
+ QQueueT:=QQueue \
+ QVectorT:=QVector \
+ QPtrDictT:=QPtrDict \
+ QIntDictT:=QIntDict \
+ QStackT:=QStack \
+ QDictIteratorT:=QDictIterator \
+ QListIteratorT:=QListIterator \
+ QCacheT:=QCache \
+ QCacheIteratorT:=QCacheIterator \
+ QIntCacheT:=QIntCache \
+ QIntCacheIteratorT:=QIntCacheIterator \
+ QIntDictIteratorT:=QIntDictIterator \
+ QPtrDictIteratorT:=QPtrDictIterator
INPUT = $(QTDIR)/doc \
$(QTDIR)/src/widgets \
$(QTDIR)/src/kernel \
diff --git a/doc/features.doc b/doc/features.doc
index 2f34e18..7159124 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -23,10 +23,10 @@
Plain text will do, but for more fancy or structured output HTML tags
and/or some of doxygen's special commands can be used.
<li>Outputs documentation in on-line format (HTML and man page) and off-line
- format (LaTeX) simulatiously (one can be disabled if desired).
+ format (LaTeX) simulatiously (any one can be disabled if desired).
Both formats are optimized for ease of reading.
-<li>Allows documentation of files, classes, templates, variables, functions,
- typedefs, enums and defines.
+<li>Allows documentation of files, namespaces, classes, structs, unions,
+ templates, variables, functions, typedefs, enums and defines.
<li>Includes a full C preprocessor to allow proper parsing of conditional
code fragments and to allow expansion of all or part of the define macros.
<li>Automatically detects public, protected and private sections, as well as
@@ -46,7 +46,7 @@
of a member function or class. Most documentation systems (such as Javadoc) only
support the former, others (such as Qt) only the latter.
<li>You can type normal HTML tags in your documentation. Doxygen will convert
- them to Latex automatically.
+ them to their equivalent Latex and man-page counterparts automatically.
<li>Allows references to documentation generated for other projects
(or another part of the same project) in a location independent way.
<li>Allows inclusion of source code examples that are automatically
@@ -58,6 +58,8 @@
file.
<li>Documentation and search engine can be transferred to another
location or machine without regenerating the documentation.
+<li>Doxygen can generate index and project files that can
+ be converted into compressed HTML by MicroSoft's HTML help workshop.
<li>Can cope with large projects easily.
</UL>
diff --git a/doc/index.doc b/doc/index.doc
index 7db1d27..7a321db 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -116,6 +116,7 @@ Thanks go to:
(which is even useful for GUI-less applications like doxygen :-)
<li>My brother <a href="http://www.stack.nl/~fidget/index.html">Frank</a>
for rendering the logos.
+<li>Harm van der Heijden for adding HTML help support.
<li>
Arnt Gulbrandsen,
Adam P. Jenkins,
@@ -174,9 +175,9 @@ Feiyi Wang,
Robert J. Clark,
Matthias Baas,
Walter Mueller,
-William van Dieten, and
-Joshua Jensen and
-many others for suggestions, patches and bug reports.
+William van Dieten,
+Joshua Jensen,
+and many others for suggestions, patches and bug reports.
</ul>
*/
diff --git a/doc/install.doc b/doc/install.doc
index 2c5f0ac..b17be97 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -79,15 +79,15 @@ The following binaries should now be available:
Doxygen was developed and tested under Linux using the following tools:
<ul>
-<li>GCC version 2.8.1
+<li>EGCS version 2.91.66
<li>GNU flex version 2.5.4
<li>GNU bison version 1.25
-<li>GNU make version 3.77
-<li>Perl version 5.001 (patch level 1m)
-<li>VIM version 5.3
+<li>GNU make version 3.76.1
+<li>Perl version 5.005_02
+<li>VIM version 5.4
<li>Netscape 4.04 & 4.5
<li>Troll Tech's tmake version 1.2 (included in the distribution)
-<li>teTeX version 0.4
+<li>teTeX version 0.9
</ul>
\htmlonly
diff --git a/doc/starting.doc b/doc/starting.doc
index 78f9309..bbb23bd 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -394,7 +394,7 @@ Formulas should be valid commands in \f$\mbox{\LaTeX}\f$'s math-mode.
\warning Currently, Doxygen is not very fault tolerant in recovering
from typos in formulas. It may have to be necessary to remove the
-file formula.repository that is written in the html directory to
+file <code>formula.repository</code> that is written in the html directory to
a rid of an incorrect formula
\subsection preprocessing Preprocessing
@@ -404,7 +404,7 @@ build-in C-preprocessor.
By default doxygen does only partial preprocessing. That is, it
evaluates conditional compilation statements (like \#if) and
-evaluates macro definitions, but is does not perform macro expansion.
+evaluates macro definitions, but it does not perform macro expansion.
So if you have the following code fragment
\verbatim
@@ -509,6 +509,25 @@ automatically by the preprocessor (like \c __cplusplus), have to be defined
by hand with doxygen's parser (this is done because these defines
are often platform/compiler specific).
+In some cases you may want to substitute a macro name or function by
+something else without exposing the result to further macro substitution.
+You can do this but using the <code>:=</code> operator instead of
+<code>=</code>
+
+As an example suppose we have the following piece of code:
+\verbatim
+#define QList QListT
+class QListT
+{
+};
+\endverbatim
+
+Then the only way to get doxygen interpret this as a class definition
+for class QList is to define:
+\verbatim
+PREDEFINED = QListT:=QList
+\endverbatim
+
As you can see doxygen's preprocessor is quite powerful, but if you want
even more flexibility you can always write an input filter and specify it on
the \c INPUT_FILTER flag.
diff --git a/doc/trouble.doc b/doc/trouble.doc
index 72013d3..5f130ec 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -48,6 +48,13 @@
int *(a[20]);
\endverbatim
then doxygen will remove the braces and correctly parse the result.
+<li>Not all names in code fragments that are include in the documentation
+ are replaced by links (for instance when using SOURCE_BROWSER = YES).
+ For a part this is because the code parser isn't smart enough at the
+ moment. I'll try to improve this in the future. But even with these
+ improvements not everthing can be properly linked to the corresponding
+ documentation, because of possible ambiguities or lack of
+ information about the context in which the code fragment is found.
</ul>
@@ -67,6 +74,6 @@ demonstrating the problem you have (make sure the example compiles!). It is
usually a good idea to send along the configuation file as well, but please
use doxygen with the <code>-s</code> flag while generating it.
-My email address: <a href="mailto:dimitri@stack.nl">dimitri@stack.nl</a>
+My e-mail address: <a href="mailto:dimitri@stack.nl">dimitri@stack.nl</a>
*/