Home
Notes
Contact Me
Documentation Systems
Doxygen
Doxygen
Homepage
http://www.stack.nl/~dimitri/doxygen/
Styles
Style
Example
JavaDoc
/**
* text here
*/
Qt
/*!
* text here
*/
Example
/*! \class LoginManager LoginManager.h "includes/LoginManager.h" \brief Maintains a Login information, which is: username, password, group number, and a handle By default blah blah blah... */ /*! \enum LoginManager::eErr \brief Error values for LoginManger. Error names are self explanitoriy. eErr::okay means no error has occured */ /*! \var LoginManager::eErr LoginManager::okay No Error. */ /*! \fn const UserEntry* LoginManager::FindUser( const char *zUsername) { return GetUser(zUsername); } \brief Gets the data for user named zUsername This data is read only. */ /*! \fn LoginManager* LoginManager::LoginManager( const char* zFilename = CONST_LOGIN_MANAGER_DEFAULT_FILENAME); \brief DO NOT USE THIS - it is primarily for testing. Use this constructor to create login information that is stored somewhere other than the default location. Or to create an instance that never gets saved to a file. \param zFilename The name of the file this LoginManger is associated with, use NULL to make it not be associated with a file at all. */