Merge branch 'feature/bug_tableofcontents_latex' of https://github.com/albert-github/doxygen into albert-github-feature/bug_tableofcontents_latex

10 files changed, 25 insertions, 12 deletions

diff --git a/doc/autolink.doc b/doc/autolink.doc
index 98556c5..ff468e4 100644
--- a/doc/autolink.doc
+++ b/doc/autolink.doc
@@ -16,7 +16,7 @@
  */
 /*! \page autolink Automatic link generation
 
-  \tableofcontents
+  \tableofcontents{html,latex}
 
   Most documentation systems have special `see also' sections where links
   to other pieces of documentation can be inserted.
diff --git a/doc/changelog.doc b/doc/changelog.doc
index 1d4eeba..0b245b6 100644
--- a/doc/changelog.doc
+++ b/doc/changelog.doc
@@ -1,5 +1,5 @@
 /** \page changelog Changelog
-\tableofcontents
+\tableofcontents{html,latex}
 \section log_1_8 1.8 Series
 
 \subsection log_1_8_14 Release 1.8.14
diff --git a/doc/commands.doc b/doc/commands.doc
index eeb5041..4b71285 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2028,15 +2028,23 @@ Make sure you have first read \ref intro "the introduction".
 \endverbatim
 
 <hr>
-\section cmdtableofcontents \\tableofcontents
+\section cmdtableofcontents \\tableofcontents['{'[option[:level]][,option[:level]]*'}']
 
   \addindex \\tableofcontents
   Creates a table of contents at the top of a page, listing all
-  sections and subsections in the page. 
+  sections and subsections in the page. The `option` can be `HTML` or `LaTeX`
+  or `XML`. When a `level` is specified this means the maximum nesting level
+  that is shown. The value of `level` should be in the range 1..5, values outside
+  this range are considered to be 5. In case no `level` is specified `level` is
+  set to 5 (show all)
+  In case no `option. is specified \c \\tableofcontents acts as if just the
+  `option` `HTML` was specified. In case of multiple \c \\tableofcontents
+  commands in a page the `option`(s) will be used additional to the already
+  specified `option`(s), but only the last `level` of an `option` is valid.
 
   \warning This command only works inside related page documentation and
            \e not in other documentation blocks and only has effect in the
-           HTML output!
+           the specified output!
 
 <hr>
 \section cmdsection \\section <section-name> (section title)
diff --git a/doc/custcmd.doc b/doc/custcmd.doc
index de9a30d..acc0224 100644
--- a/doc/custcmd.doc
+++ b/doc/custcmd.doc
@@ -16,7 +16,7 @@
  */
 /*! \page custcmd Custom Commands
 
-\tableofcontents
+\tableofcontents{html,latex}
 
 Doxygen provides a large number of \ref commands "special commands", 
 \ref xmlcmds "XML commands", and \ref htmlcmds "HTML commands".
diff --git a/doc/customize.doc b/doc/customize.doc
index e2d53db..a92e6d9 100644
--- a/doc/customize.doc
+++ b/doc/customize.doc
@@ -16,7 +16,7 @@
  */
 /*! \page customize Customizing the output
 
-\tableofcontents
+\tableofcontents{html,latex}
 
 Doxygen provides various levels of customization. 
 The section \ref minor_tweaks "Minor Tweaks" discusses what to 
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index e72ce95..f02e55b 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -15,7 +15,7 @@
  *
  */
 /*! \page docblocks Documenting the code
-\tableofcontents
+\tableofcontents{html,latex}
 
 This chapter covers two topics:
 1. How to put comments in your code such that doxygen incorporates them in
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index 3e4cd49..95e1ed6 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -70,9 +70,13 @@
 \hfuzz=15pt
 \setlength{\emergencystretch}{15pt}
 \setlength{\parindent}{0pt}
-\setlength{\parskip}{0.2cm}
+\newcommand{\doxynormalparskip}{\setlength{\parskip}{0.2cm}}
+\newcommand{\doxytocparskip}{\setlength{\parskip}{0.2cm}}
+\doxynormalparskip
 \hbadness=750
 \tolerance=750
+\usepackage{etoc}
+\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
 \begin{document}
 \pagenumbering{alph}
 \begin{titlepage}
@@ -85,6 +89,7 @@ Written by Dimitri van Heesch\\[2ex]
 \end{titlepage}
 \clearemptydoublepage
 \pagenumbering{Roman}
+\chapter*{Contents}
 \tableofcontents
 \clearemptydoublepage
 \pagenumbering{arabic}
diff --git a/doc/faq.doc b/doc/faq.doc
index a91a2f5..e9c93d8 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -16,7 +16,7 @@
  */
 /*! \page faq Frequently Asked Questions
 
-\tableofcontents
+\tableofcontents{html,latex}
 
 
 \section faq_index How to get information on the index page in HTML?
diff --git a/doc/install.doc b/doc/install.doc
index f981431..497a0c0 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -17,7 +17,7 @@
 /*! \page install Installation
 
 \addindex installation
-\tableofcontents
+\tableofcontents{html,latex}
 
 First go to the 
 <a href="http://www.doxygen.org/download.html">download</a> page
diff --git a/doc/starting.doc b/doc/starting.doc
index e39aa25..0765a3b 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -15,7 +15,7 @@
  *
  */
 /*! \page starting Getting started
-\tableofcontents
+\tableofcontents{html,latex}
 
 The executable \c doxygen is the main program that parses the sources and 
 generates the documentation. See section \ref doxygen_usage for more