summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile2
-rw-r--r--doc/Makefile.in2
-rw-r--r--doc/Makefile.latex2
-rw-r--r--doc/Makefile.win.in2
-rw-r--r--doc/autolink.doc2
-rw-r--r--doc/commands.doc2
-rw-r--r--doc/config.doc2
-rw-r--r--doc/doxygen.sty2
-rw-r--r--doc/doxygen_manual.tex2
-rw-r--r--doc/doxygen_usage.doc2
-rw-r--r--doc/doxysearch_usage.doc2
-rw-r--r--doc/doxytag_usage.doc2
-rw-r--r--doc/faq.doc13
-rw-r--r--doc/features.doc2
-rw-r--r--doc/history.doc2
-rw-r--r--doc/htmlcmds.doc2
-rw-r--r--doc/index.doc2
-rw-r--r--doc/install.doc2
-rw-r--r--doc/installdox_usage.doc2
-rw-r--r--doc/language.doc2
-rw-r--r--doc/output.doc2
-rw-r--r--doc/starting.doc2
-rw-r--r--doc/todo.doc2
-rw-r--r--doc/trouble.doc2
24 files changed, 35 insertions, 24 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 3c3e114..292db32 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -1,5 +1,5 @@
#
-# $Id$
+#
#
# Copyright (C) 1997-1999 by Dimitri van Heesch.
#
diff --git a/doc/Makefile.in b/doc/Makefile.in
index c6308bf..fe1d9d2 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -1,5 +1,5 @@
#
-# $Id$
+#
#
# Copyright (C) 1997-2000 by Dimitri van Heesch.
#
diff --git a/doc/Makefile.latex b/doc/Makefile.latex
index b4e4379..3c31b09 100644
--- a/doc/Makefile.latex
+++ b/doc/Makefile.latex
@@ -1,5 +1,5 @@
#
-# $Id$
+#
#
# Copyright (C) 1997-2000 by Dimitri van Heesch.
#
diff --git a/doc/Makefile.win.in b/doc/Makefile.win.in
index e151ecc..c9611eb 100644
--- a/doc/Makefile.win.in
+++ b/doc/Makefile.win.in
@@ -1,5 +1,5 @@
#
-# $Id$
+#
#
# Copyright (C) 1997-2000 by Dimitri van Heesch.
#
diff --git a/doc/autolink.doc b/doc/autolink.doc
index 4cb892b..930e95b 100644
--- a/doc/autolink.doc
+++ b/doc/autolink.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/commands.doc b/doc/commands.doc
index 497e26d..cdbd4a5 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/config.doc b/doc/config.doc
index 906c86e..bfbd062 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/doxygen.sty b/doc/doxygen.sty
index e38ddc8..c0769ec 100644
--- a/doc/doxygen.sty
+++ b/doc/doxygen.sty
@@ -1,5 +1,5 @@
%
-% $Id$
+%
%
% Copyright (C) 1997-2000 by Dimitri van Heesch.
%
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index f256d06..bce9b76 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -1,5 +1,5 @@
%
-% $Id$
+%
%
% Copyright (C) 1997-2000 by Dimitri van Heesch.
%
diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc
index 47e7431..12baef5 100644
--- a/doc/doxygen_usage.doc
+++ b/doc/doxygen_usage.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/doxysearch_usage.doc b/doc/doxysearch_usage.doc
index 79a418e..1aadceb 100644
--- a/doc/doxysearch_usage.doc
+++ b/doc/doxysearch_usage.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/doxytag_usage.doc b/doc/doxytag_usage.doc
index 0a4de9c..d90611e 100644
--- a/doc/doxytag_usage.doc
+++ b/doc/doxytag_usage.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/faq.doc b/doc/faq.doc
index 28fd574..0dae9e5 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
@@ -34,6 +34,17 @@ You should use the \\mainpage command inside a comment block like this:
*/
\endverbatim
+<li><b>When I set EXTRACT_ALL to NO non of my function are shown in the documentation.</b></li>
+
+In order for global functions, variables, enums, typedefs, and defines
+to be documented you should document the file in which these commands are
+located using a (non-empty) comment block containing a \file (or @file)
+command.
+
+Alternatively, you can put all members in a group (or module)
+using the \ingroup command and then document the group using a comment
+block containing the \defgroup command.
+
<li><b>How can I avoid that some code fragment is parsed by Doxyen?</b>
<p>
You can use Doxygen's preprocessor for this:
diff --git a/doc/features.doc b/doc/features.doc
index 1984e68..8363174 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/history.doc b/doc/history.doc
index c0b2305..9092b97 100644
--- a/doc/history.doc
+++ b/doc/history.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc
index e539d7e..8b8b1c3 100644
--- a/doc/htmlcmds.doc
+++ b/doc/htmlcmds.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/index.doc b/doc/index.doc
index a28efec..b47ab4a 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/install.doc b/doc/install.doc
index 6617900..9fc0fef 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/installdox_usage.doc b/doc/installdox_usage.doc
index 1689602..b3ea7d8 100644
--- a/doc/installdox_usage.doc
+++ b/doc/installdox_usage.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/language.doc b/doc/language.doc
index b3ec52a..4842b68 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/output.doc b/doc/output.doc
index 2a8f890..6dee1fc 100644
--- a/doc/output.doc
+++ b/doc/output.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/starting.doc b/doc/starting.doc
index 96a2fc1..07dc47b 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/todo.doc b/doc/todo.doc
index faca7cd..c58358f 100644
--- a/doc/todo.doc
+++ b/doc/todo.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*
diff --git a/doc/trouble.doc b/doc/trouble.doc
index b8f742b..b8e95f1 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * $Id$
+ *
*
* Copyright (C) 1997-2000 by Dimitri van Heesch.
*