I'm having problems with writing documentations for my classes and their member functions. I've found what I want in Qt base classes. Here are several rows from "QVector.cpp":
/*!
\class QVector
\brief The QVector class is a template class that provides a dynamic array.
\ingroup tools
\ingroup shared
\reentrant
QVector\<T\> is one of Qt's generic \l{container classes}. It
stores its items in adjacent memory locations and provides fast
index-based access.
QList\<T\>, QLinkedList\<T\>, and QVarLengthArray\<T\> provide
similar functionality. Here's an overview:
\list
\i For most purposes, QList is the right class to use. Operations
like prepend() and insert() are usually faster than with
..........
*/
/*!
\fn QVector<T> QVector::mid(int pos, int length = -1) const
Returns a vector whose elements are copied from this vector....
.........
*/
// ....
/*!
\class QVector
\brief The QVector class is a template class that provides a dynamic array.
\ingroup tools
\ingroup shared
\reentrant
QVector\<T\> is one of Qt's generic \l{container classes}. It
stores its items in adjacent memory locations and provides fast
index-based access.
QList\<T\>, QLinkedList\<T\>, and QVarLengthArray\<T\> provide
similar functionality. Here's an overview:
\list
\i For most purposes, QList is the right class to use. Operations
like prepend() and insert() are usually faster than with
..........
*/
/*!
\fn QVector<T> QVector::mid(int pos, int length = -1) const
Returns a vector whose elements are copied from this vector....
.........
*/
// ....
To copy to clipboard, switch view to plain text mode
When I'm trying to do the same in my ".cpp" files, nothing happens (hovering the functions' calls in other files doesn't show my documentation). I tried to find some documentation about this and the keywords (tags) as well (like "\class", "\brief", "\ingroup"...), but I couldn't find anything. Can anyone help or give any links to documentation concerning this?
Bookmarks