summaryrefslogtreecommitdiffstats
path: root/doc/starting.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/starting.doc')
-rw-r--r--doc/starting.doc16
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/starting.doc b/doc/starting.doc
index 8e3e0d2..d90d136 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -38,6 +38,17 @@ tries to be complete):
\image html infoflow.gif "Doxygen information flow"
\image latex infoflow.eps "Doxygen information flow" width=14cm
+\section step0 Step 0: Check if doxygen supports your programming language
+
+First, assure that your programming language has a reasonable chance of being
+recognized by Doxygen. These languages are supported by default: C, C++, C#,
+Objective-C, IDL, Java, VHDL, PHP, Python, Fortran, and D. It
+is possible to configure certain filetype extensions to use certain parsers:
+see the \ref cfg_extension_mapping "Configuration/ExtensionMappings" for details.
+Also, completely different languages can be supported by using preprocessor
+programs: see the <a href="http://www.doxygen.org/helpers.html">Helpers page</a>
+for details.
+
\section step1 Step 1: Creating a configuration file
Doxygen uses a configuration file to determine all of its settings.
@@ -163,7 +174,8 @@ require a browser that supports DHTML and Javascript.
\subsection latex_out LaTeX output
\addindex LaTeX
The generated \f$\mbox{\LaTeX}\f$ documentation must first be compiled by
-a \f$\mbox{\LaTeX}\f$ compiler (I use a recent teTeX distribution).
+a \f$\mbox{\LaTeX}\f$ compiler (I use a recent teTeX distribution for Linux
+and MacOSX and MikTex for Windows).
To simplify the process of compiling the generated
documentation, \c doxygen writes a \c Makefile into the \c latex directory.
@@ -250,7 +262,7 @@ basically two options:
</ol>
Files can only be documented using the second option, since there is
no way to put a documentation block before a file. Of course, file members
-(functions, variable, typedefs, defines) do not need an explicit
+(functions, variables, typedefs, defines) do not need an explicit
structural command; just putting a special documentation block in front or
behind them will do.