Hi Dimitri and all,
I havbe found one and, well, I guess a half, bugs with simple member
groups. One apparently is related to not using the \name command (that's
the half), the other one is a relatively serious LaTeX error.
I'll start with the latter, since there seems to be no good workaround
for this one.
Let's say I have a class Test coded and documented like this:
class Test
{
public :
/** Brief group description.
*
* Second paragraph of group description.
*
* \name something
*/
/*@{*/
int a;
int b;
/*@}*/
};
"a" and "b" are grouped together in the group "something", but the
"Public Attributes" part of the generated LaTeX file looks like this:
\subsection*{Public Attributes}
\begin{CompactItemize}
\end{CompactItemize}
\begin{Indent}{\bf something}\par
{\em Brief group description.
Second paragraph of group description.}\begin{CompactItemize}
\item
int {\bf a}
\item
int {\bf b}
\end{CompactItemize}
\end{Indent}
This generates a LaTeX error, because the CompactItemize environment in
lines 2 and 3 is empty. In general, LaTeX does not allow list
environments without a single \item.
The other problem arises when I don't include a \name command - this
actually is the case in several places of the project I am currently
working on: Some members are related to each other and therefore should
be grouped together; however, a group name seems superfluous. The result
is about the same in HTML and LaTeX output: The group structure appears
to get lost as well as the second documentation paragraph. Additionally,
the group description is not associated to "a" and "b", but just to "a".
E.g., the LaTeX output looks like this:
\section{Test Class Reference}
\label{classTest}\index{Test@{Test}}
{\tt \#include $<$test.h$>$}
\subsection*{Public Attributes}
\begin{CompactItemize}
\end{CompactItemize}
{\bf }\par
\begin{CompactItemize}
\item
int {\bf a}
\begin{CompactList}\small\item\em Brief group
description.\item\end{CompactList}\item
int {\bf b}
\end{CompactItemize}
\subsection{Member Data Documentation}
\index{Test@{Test}!a@{a}}
\index{a@{a}!Test@{Test}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int
Test::a}\label{classTest_m0}
Brief group description.
Definition at line 9 of file test.h.\index{Test@{Test}!b@{b}}
\index{b@{b}!Test@{Test}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int
Test::b}\label{classTest_m1}
Definition at line 10 of file test.h.
The documentation for this class was generated from the following
file:\begin{CompactItemize}
\item
{\bf test.h}\end{CompactItemize}
Just to make sure: I am using the latest CVS checkout.
Regards,
--
Raimund Klein <kl...@or...>
Orthogon GmbH, Hastedter Osterdeich 222, D-28207 Bremen
|
