Clarify the documentation a bit.

Issue spotted by zaroth.
This commit is contained in:
Mark de Wever 2011-04-09 16:00:23 +00:00
parent 23680e0a13
commit 634051f7e2

View file

@ -185,11 +185,12 @@ the files after which I dive more into the implementation of the file.
Signature T* foo() { return foo\_; } Almost the same as the
reference version and is used for members that are pointers. The
text of the reference also applies here.
Furthermore this version often has no normal getter but may have a
setter.
\end{description}
The setter is normally available. The getter is often omitted when a
reference or pointer function are used. Especially it there is a const
version of these functions.
\item[\Lref{progress_bar.hpp:state}]
The state has the list of states available and normally has COUNT as
last value, which in turn is used in the constructor to initialize the