summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2010-06-25 11:31:51 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2010-06-25 11:31:51 (GMT)
commitc37c8626674dd6ba0d53dcad84dd4bb5d92005a4 (patch)
treefa51c4ac8c1fe241b2d6c4af9d2f9a1297ce8e0a /doc
parent0c6ee149829948582e5e5c1b96c8b3105b02672a (diff)
downloadDoxygen-c37c8626674dd6ba0d53dcad84dd4bb5d92005a4.zip
Doxygen-c37c8626674dd6ba0d53dcad84dd4bb5d92005a4.tar.gz
Doxygen-c37c8626674dd6ba0d53dcad84dd4bb5d92005a4.tar.bz2
Release-1.7.1
Diffstat (limited to 'doc')
-rw-r--r--doc/config.doc10
-rw-r--r--doc/docblocks.doc32
-rw-r--r--doc/index.hhp.txt108
-rw-r--r--doc/install.doc13
4 files changed, 151 insertions, 12 deletions
diff --git a/doc/config.doc b/doc/config.doc
index e46725e..a4402d1 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -122,6 +122,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_filter_source_files FILTER_SOURCE_FILES
\refitem cfg_force_local_includes FORCE_LOCAL_INCLUDES
\refitem cfg_formula_fontsize FORMULA_FONTSIZE
+\refitem cfg_formula_transparent FORMULA_TRANSPARENT
\refitem cfg_full_path_names FULL_PATH_NAMES
\refitem cfg_generate_autogen_def GENERATE_AUTOGEN_DEF
\refitem cfg_generate_buglist GENERATE_BUGLIST
@@ -1588,6 +1589,15 @@ and Class Hierarchy pages using a tree view instead of an ordered list.
when you change the font size after a successful doxygen run you need
to manually remove any <code>form_*.png</code> images from the HTML
output directory to force them to be regenerated.
+
+\anchor cfg_formula_transparent
+<dt>\c FORMULA_TRANSPARENT <dd>
+ \addindex FORMULA_TRANSPARENT
+ Use the \c FORMULA_TRANPARENT tag to determine whether or not the images
+ generated for formulas are transparent PNGs. Transparent PNGs are
+ not supported properly for IE 6.0, but are supported on all modern browsers.
+ Note that when changing this option you need to delete any form_*.png files
+ in the HTML output before the changes have effect.
</dl>
\section latex_output LaTeX related options
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index ebbe879..aa9e873 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -448,4 +448,36 @@ config file. This will also affect a number of other settings. When they
were not already set correctly doxygen will produce a warning telling which
settings where overruled.
+\section fortranblocks Special documentation blocks in Fortran
+
+When using doxygen for Fortran code you should
+set \ref cfg_optimize_for_fortran "OPTIMIZE_FOR_FORTRAN" to \c YES.
+
+For fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to
+continuate a one line comment into a multi-line comment.
+
+Here is an example of a documented Fortran subroutine:
+\verbatim
+ !> Build the restriction matrix for the aggregation
+ !! method.
+ !! @param aggr information about the aggregates
+ !! @todo Handle special case
+ subroutine IntRestBuild(A,aggr,Restrict,A_ghost)
+ implicit none
+ Type(SpMtx), intent(in) :: A !< our fine level matrix
+ Type(Aggrs), intent(in) :: aggr
+ Type(SpMtx), intent(out) :: Restrict !< Our restriction matrix
+\endverbatim
+
+As a alternative you can also use comments in fixed format code:
+
+\verbatim
+C> Function comment
+C> another line of comment
+ function A(i)
+C> input parameter
+ integer i
+ end function A
+\endverbatim
+
*/
diff --git a/doc/index.hhp.txt b/doc/index.hhp.txt
new file mode 100644
index 0000000..b676d83
--- /dev/null
+++ b/doc/index.hhp.txt
@@ -0,0 +1,108 @@
+examples/afterdoc/html/tab_a.png
+examples/afterdoc/html/tab_b.png
+examples/afterdoc/html/tab_h.png
+examples/afterdoc/html/tab_s.png
+examples/author/html/tab_a.png
+examples/author/html/tab_b.png
+examples/author/html/tab_h.png
+examples/author/html/tab_s.png
+examples/autolink/html/tab_a.png
+examples/autolink/html/tab_b.png
+examples/autolink/html/tab_h.png
+examples/autolink/html/tab_s.png
+examples/class/html/tab_a.png
+examples/class/html/tab_b.png
+examples/class/html/tab_h.png
+examples/class/html/tab_s.png
+examples/define/html/tab_a.png
+examples/define/html/tab_b.png
+examples/define/html/tab_h.png
+examples/define/html/tab_s.png
+examples/diagrams/html/tab_a.png
+examples/diagrams/html/tab_b.png
+examples/diagrams/html/tab_h.png
+examples/diagrams/html/tab_s.png
+examples/docstring/html/tab_a.png
+examples/docstring/html/tab_b.png
+examples/docstring/html/tab_h.png
+examples/docstring/html/tab_s.png
+examples/enum/html/tab_a.png
+examples/enum/html/tab_b.png
+examples/enum/html/tab_h.png
+examples/enum/html/tab_s.png
+examples/example/html/tab_a.png
+examples/example/html/tab_b.png
+examples/example/html/tab_h.png
+examples/example/html/tab_s.png
+examples/file/html/tab_a.png
+examples/file/html/tab_b.png
+examples/file/html/tab_h.png
+examples/file/html/tab_s.png
+examples/func/html/tab_a.png
+examples/func/html/tab_b.png
+examples/func/html/tab_h.png
+examples/func/html/tab_s.png
+examples/group/html/tab_a.png
+examples/group/html/tab_b.png
+examples/group/html/tab_h.png
+examples/group/html/tab_s.png
+examples/include/html/tab_a.png
+examples/include/html/tab_b.png
+examples/include/html/tab_h.png
+examples/include/html/tab_s.png
+examples/jdstyle/html/tab_a.png
+examples/jdstyle/html/tab_b.png
+examples/jdstyle/html/tab_h.png
+examples/jdstyle/html/tab_s.png
+examples/manual/html/tab_a.png
+examples/manual/html/tab_b.png
+examples/manual/html/tab_h.png
+examples/manual/html/tab_s.png
+examples/memgrp/html/tab_a.png
+examples/memgrp/html/tab_b.png
+examples/memgrp/html/tab_h.png
+examples/memgrp/html/tab_s.png
+examples/mux/html/tab_a.png
+examples/mux/html/tab_b.png
+examples/mux/html/tab_h.png
+examples/mux/html/tab_s.png
+examples/overload/html/tab_a.png
+examples/overload/html/tab_b.png
+examples/overload/html/tab_h.png
+examples/overload/html/tab_s.png
+examples/page/html/tab_a.png
+examples/page/html/tab_b.png
+examples/page/html/tab_h.png
+examples/page/html/tab_s.png
+examples/par/html/tab_a.png
+examples/par/html/tab_b.png
+examples/par/html/tab_h.png
+examples/par/html/tab_s.png
+examples/pyexample/html/tab_a.png
+examples/pyexample/html/tab_b.png
+examples/pyexample/html/tab_h.png
+examples/pyexample/html/tab_s.png
+examples/qtstyle/html/tab_a.png
+examples/qtstyle/html/tab_b.png
+examples/qtstyle/html/tab_h.png
+examples/qtstyle/html/tab_s.png
+examples/relates/html/tab_a.png
+examples/relates/html/tab_b.png
+examples/relates/html/tab_h.png
+examples/relates/html/tab_s.png
+examples/restypedef/html/tab_a.png
+examples/restypedef/html/tab_b.png
+examples/restypedef/html/tab_h.png
+examples/restypedef/html/tab_s.png
+examples/structcmd/html/tab_a.png
+examples/structcmd/html/tab_b.png
+examples/structcmd/html/tab_h.png
+examples/structcmd/html/tab_s.png
+examples/tag/html/tab_a.png
+examples/tag/html/tab_b.png
+examples/tag/html/tab_h.png
+examples/tag/html/tab_s.png
+examples/template/html/tab_a.png
+examples/template/html/tab_b.png
+examples/template/html/tab_h.png
+examples/template/html/tab_s.png
diff --git a/doc/install.doc b/doc/install.doc
index b213555..b668dde 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -366,21 +366,13 @@ before running make.
\section install_src_windows Compiling from source on Windows
-From version 1.5.0 onwards, build files are provided for Visual Studio 2005.
+From version 1.7.0 onwards, build files are provided for Visual Studio 2008.
Also the free (as in beer) "Express" version of Developer Studio can be used to
compile doxygen. Alternatively, you can compile doxygen
\ref install_src_unix "the Unix way" using
<a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a>
or <a href="http://www.mingw.org/">MinGW</a>.
-Before you can compile doxygen you need to download and install the C++ compiler of
-Visual Studio. Since Microsoft apparently wants to lure everyone into using their
-.NET stuff, they made things somewhat difficult when you use the Express version.
-You need to
-<a href="http://msdn2.microsoft.com/en-gb/express/aa700755.aspx">
-do some manual steps</a> in order to setup a proper working environment for building
-native win32 applications such as Doxygen.
-
The next step is to install unxutils (see http://sourceforge.net/projects/unxutils).
This packages contains the tools \c flex and \c bison which are needed during the
compilation process if you use a CVS snapshot of doxygen (the official source releases
@@ -411,9 +403,6 @@ the project in the solutions explorer, and selecting Build.
Note that compiling Doxywizard currently requires Qt version 4
(see http://qt.nokia.com/products/platform/qt-for-windows).
-If you do not have a commercial license, you can build Doxywizard with the open
-source version (see http://qtwin.sourceforge.net/qt3-win32/compile-msvc-2005.php),
-but I have not tried this myself.
Also read the next section for additional tools you may need to install to run
doxygen with certain features enabled.