Mercurial > hg > forks > UniversalIndentGUI

changeset 251:c1e43f914649

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Changed the documentation to show brief description. git-svn-id: svn://svn.code.sf.net/p/universalindent/code/trunk@460 59b1889a-e5ac-428c-b0c7-476e01d41282
author thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
date Tue, 21 Aug 2007 10:42:04 +0000
parents 18f769875961
children 7b4f055a20d8
files src/aboutdialog.cpp src/highlighter.cpp src/indenthandler.cpp src/main.cpp src/mainwindow.cpp src/uiguisettings.cpp src/uiguisettingsdialog.cpp
diffstat 7 files changed, 146 insertions(+), 97 deletions(-) [+]
line wrap: on
line diff
--- a/src/aboutdialog.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/aboutdialog.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -25,7 +25,7 @@
 */
 
 /*!
-    The constructor calls the setup function for the ui created by uic and adds
+    \brief The constructor calls the setup function for the ui created by uic and adds
     the GPL text to the text edit.
  */
 AboutDialog::AboutDialog(QWidget *parent, QString version, QString revision, QString buildDate) :
@@ -73,7 +73,7 @@
 
 
 /*!
-    This slot is being called, when the link in the about dialog is being clicked.
+    \brief This slot is being called, when the link in the about dialog is being clicked.
  */
 void AboutDialog::linkClicked(const QUrl &link) {
     authorTextBrowser->setHtml(textBrowserSavedContent);
@@ -82,7 +82,7 @@
 
 
 /*!
-    Catches language change events and retranslates all needed widgets.
+    \brief Catches language change events and retranslates all needed widgets.
  */
 void AboutDialog::changeEvent(QEvent *event) {
     if (event->type() == QEvent::LanguageChange) {
@@ -99,7 +99,7 @@
 
 
 /*!
-    Reimplements the dialog execution function to init the credits scroller.
+    \brief Reimplements the dialog execution function to init the credits scroller.
  */
 int AboutDialog::exec() {
     //creditsTextBrowser->verticalScrollBar()->setValue(0);
@@ -109,7 +109,7 @@
 
 
 /*!
-    This slot is called each timer timeout to scroll the credits textbrowser.
+    \brief This slot is called each timer timeout to scroll the credits textbrowser.
     Also changes the scroll direction and speed when reaching the start or end.
  */
 void AboutDialog::scroll() {
--- a/src/highlighter.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/highlighter.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -21,13 +21,16 @@
 
 #include "highlighter.h"
 
+//! \defgroup grp_EditorComponent All concerning editor widget.
+
 /*!
     \class Highlighter
+    \ingroup grp_EditorComponent
     \brief Highlighter used by QTextEdit fields to syntax highlight cpp source code
 */
 
 /*!
-    The constructor initializes some regular expressions and keywords to identify cpp tokens
+    \brief The constructor initializes some regular expressions and keywords to identify cpp tokens
  */
 Highlighter::Highlighter(QsciScintilla *parent, QSettings *settings)
 : QObject(parent)
@@ -80,7 +83,7 @@
 
 
 /*!
-    Returns the available highlighters as QStringList.
+    \brief Returns the available highlighters as QStringList.
  */
 QStringList Highlighter::getAvailableHighlighters() {
     return mapHighlighternameToExtension.keys();
@@ -88,7 +91,7 @@
 
 
 /*!
-    This slot handles signals coming from selecting another syntax highlighter.
+    \brief This slot handles signals coming from selecting another syntax highlighter.
  */
 void Highlighter::highlighterChanged(QAction* highlighterAction) {
 	QString highlighterName = highlighterAction->text();
@@ -102,7 +105,7 @@
 
 
 /*!
-    Turns the syntax parser on.
+    \brief Turns the syntax parser on.
 */
 void Highlighter::turnHighlightOn() {
     highlightningIsOn = true;
@@ -111,7 +114,7 @@
 }
 
 /*!
-    Turns the syntax parser off.
+    \brief Turns the syntax parser off.
 */
 void Highlighter::turnHighlightOff() {
     highlightningIsOn = false;
@@ -120,7 +123,7 @@
 
 
 /*!
-    Read the settings for the current lexer from the settings file.
+    \brief Read the settings for the current lexer from the settings file.
  */
 bool Highlighter::readCurrentSettings( const char *prefix )
 {
@@ -201,7 +204,7 @@
 
 
 /*!
-    Write the settings for the current lexer to the settings file.
+    \brief Write the settings for the current lexer to the settings file.
  */
 void Highlighter::writeCurrentSettings( const char *prefix )
 {
@@ -285,7 +288,7 @@
 
 
 /*!
-    Sets the proper highlighter / lexer for the given file \a extension. Returns the index of the used lexer in the list.
+    \brief Sets the proper highlighter / lexer for the given file \a extension. Returns the index of the used lexer in the list.
  */
 int Highlighter::setLexerForExtension( QString extension ) {
     int indexOfHighlighter = 0;
--- a/src/indenthandler.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/indenthandler.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -19,8 +19,11 @@
 
 #include "indenthandler.h"
 
+//! \defgroup grp_Indenter All concerning handling of the indenter.
+
 /*!
     \class IndentHandler
+    \ingroup grp_Indenter
     \brief A widget for handling many indenters that are configured by an ini file.
 
     This is a widget that is used by the main window. It handles access to the
@@ -31,9 +34,11 @@
 
 
 /*!
-    Constructor of the indent handler. By calling this constructor the indenter
-    to be loaded, can be selected by setting its \a indenterID, which is the number
-    of found indenter ini files in alphabetic order starting at index 0.
+    \brief Constructor of the indent handler. 
+    
+    By calling this constructor the indenter to be loaded, can be selected by setting 
+    its \a indenterID, which is the number of found indenter ini files in alphabetic 
+    order starting at index 0.
  */
 IndentHandler::IndentHandler(QString dataDirPathStr, int indenterID, QMainWindow *mainWindow, QWidget *parent)
     : QWidget(parent)
@@ -79,7 +84,7 @@
 
 
 /*!
-    Creates the content for a shell script that can be used as a external too call
+    \brief Creates the content for a shell script that can be used as a external too call
     to indent a as parameter defined file.
  */
 QString IndentHandler::generateCommandlineCall(QString inputFileExtension) {
@@ -180,8 +185,10 @@
 
 
 /*!
-   Format \a sourceCode by calling the indenter. The \a inputFileExtension has to be given as parameter
-   so the called indenter can identify the programming language if needed.
+   \brief Format \a sourceCode by calling the indenter. 
+   
+   The \a inputFileExtension has to be given as parameter so the called indenter 
+   can identify the programming language if needed.
  */
 QString IndentHandler::callIndenter(QString sourceCode, QString inputFileExtension) {
     Q_ASSERT_X( !inputFileName.isEmpty(), "callIndenter", "inputFileName is empty" );
@@ -367,7 +374,7 @@
 
 
 /*!
-    Generates and returns a string with all parameters needed to call the indenter.
+    \brief Generates and returns a string with all parameters needed to call the indenter.
  */
 QString IndentHandler::getParameterString() {
 
@@ -424,7 +431,7 @@
 
 
 /*!
-    Write settings for the indenter to a config file.
+    \brief Write settings for the indenter to a config file.
  */
 void IndentHandler::writeConfigFile(QString paramString) {
     Q_ASSERT_X( !configFilename.isEmpty(), "writeConfigFile", "configFilename is empty" );
@@ -439,7 +446,7 @@
 
 
 /*!
-    Load the config file for the indenter and apply the settings made there.
+    \brief Load the config file for the indenter and apply the settings made there.
  */
 void IndentHandler::loadConfigFile(QString filePathName) {
     Q_ASSERT_X( !filePathName.isEmpty(), "loadConfigFile", "filePathName is empty" );
@@ -618,7 +625,7 @@
 }
 
 /*!
-    Opens and parses the indenter ini file that is declared by \a iniFilePath.
+    \brief Opens and parses the indenter ini file that is declared by \a iniFilePath.
  */
 void IndentHandler::readIndentIniFile(QString iniFilePath) {
     Q_ASSERT_X( !iniFilePath.isEmpty(), "readIndentIniFile", "iniFilePath is empty" );
@@ -896,8 +903,10 @@
 
 
 /*!
+    \brief Searches and returns all indenters a configuration file is found for.
+
     Opens all uigui ini files found in the list \a indenterIniFileList, opens each ini file
-    and reads the there defined real name of the indenter. These names are being returned as QStringList
+    and reads the there defined real name of the indenter. These names are being returned as QStringList.
  */
 QStringList IndentHandler::getAvailableIndenters() {
     QStringList indenterNamesList;
@@ -927,7 +936,7 @@
 
 
 /*!
-    Deletes all elements in the toolbox and initializes the indenter selected by \a indenterID.
+    \brief Deletes all elements in the toolbox and initializes the indenter selected by \a indenterID.
  */
 void IndentHandler::setIndenter(int indenterID) {
     // TODO: This function is never called because out of the mainwindow object a new indenthandler object is created if another indenter is selected.
@@ -962,14 +971,14 @@
 
 
 /*!
-    Returns a string containing by the indenter supported file types/extensions devided by a space.
+    \brief Returns a string containing by the indenter supported file types/extensions devided by a space.
  */
 QString IndentHandler::getPossibleIndenterFileExtensions() {
     return fileTypes;
 }
 
 /*!
-    Returns the path and filename of the current indenter config file.
+    \brief Returns the path and filename of the current indenter config file.
  */
 QString IndentHandler::getIndenterCfgFile() {
     QFileInfo fileInfo( dataDirctoryStr + configFilename );
--- a/src/main.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/main.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -22,7 +22,7 @@
 
 
 /*!
-    Entry point to UniversalIndentGUI application. Does not evaluate any command line parameters.
+    \brief Entry point to UniversalIndentGUI application. Does not evaluate any command line parameters.
  */
 int main(int argc, char *argv[])
 {
--- a/src/mainwindow.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/mainwindow.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -32,7 +32,7 @@
  */
 
 /*!
-    Constructs the main window.
+    \brief Constructs the main window.
  */
 MainWindow::MainWindow(QWidget *parent) : QMainWindow(parent) {
     // set the program version, revision and date, which is shown in the main window title and in the about dialog.
@@ -89,7 +89,7 @@
 
 
 /*!
-    Initializes the main window by creating the main gui and make some settings.
+    \brief Initializes the main window by creating the main gui and make some settings.
  */
 void MainWindow::initMainWindow() {
     // Generate gui as it is build in the file "indentgui.ui"
@@ -167,7 +167,7 @@
 
 
 /*!
-    Creates and inits the tool bar. It is added to the main window.
+    \brief Creates and inits the tool bar. It is added to the main window.
  */
 void MainWindow::initToolBar() {
     // Create the tool bar and add it to the main window.
@@ -192,7 +192,7 @@
 
 
 /*!
-   Create and initialize the text editor component. It uses the QScintilla widget.
+    \brief Create and initialize the text editor component. It uses the QScintilla widget.
  */
 void MainWindow::initTextEditor() {
     // Create the QScintilla widget and add it to the layout.
@@ -230,7 +230,7 @@
 
 
 /*!
-    Create and init the syntax highlighter and set it to use the QScintilla edit component.
+    \brief Create and init the syntax highlighter and set it to use the QScintilla edit component.
  */
 void MainWindow::initSyntaxHighlighter() {
     // Create the highlighter.
@@ -248,6 +248,8 @@
 
 
 /*!
+    \brief Initializes the language of UniversalIndentGUI.
+
     If the program language is defined in the settings, the corresponding language
     file will be loaded and set for the application. If not set there, the system
     default language will be set, if a translation file for that language exists.
@@ -303,7 +305,7 @@
 
 
 /*!
-    Creates and initializes the indenter.
+    \brief Creates and initializes the indenter.
  */
 void MainWindow::initIndenter() {
     // Get Id of last selected indenter.
@@ -345,7 +347,7 @@
 
 
 /*!
-    Creates the by \a indenterID selected indent handler object and adds the indent widget to its layout.
+    \brief Creates the by \a indenterID selected indent handler object and adds the indent widget to its layout.
  */
 void MainWindow::selectIndenter(int indenterID) {
     IndentHandler *oldIndentHandler = indentHandler;
@@ -395,7 +397,8 @@
 
 
 /*!
-    Tries to load the by \a filePath defined file and returns its content as QString.
+    \brief Tries to load the by \a filePath defined file and returns its content as QString.
+
     If the file could not be loaded a error dialog will be shown.
  */
 QString MainWindow::loadFile(QString filePath) {
@@ -424,7 +427,8 @@
 
 
 /*!
-    Calls the source file open dialog to load a source file for the formatting preview.
+    \brief Calls the source file open dialog to load a source file for the formatting preview.
+
     If the file was successfully loaded the indenter will be called to generate the formatted source code.
  */
 void MainWindow::openSourceFileDialog(QString fileName) {
@@ -468,7 +472,8 @@
 
 
 /*!
-    Calls the source file save as dialog to save a source file under a chosen name.
+    \brief Calls the source file save as dialog to save a source file under a chosen name.
+
     If the file already exists and it should be overwritten, a warning is shown before.
  */
 bool MainWindow::saveasSourceFileDialog() {
@@ -504,7 +509,8 @@
 
 
 /*!
-    Saves the currently shown source code to the last save or opened source file.
+    \brief Saves the currently shown source code to the last save or opened source file.
+
     If no source file has been opened, because only the static example has been loaded,
     the save as file dialog will be shown.
  */
@@ -528,7 +534,8 @@
 
 
 /*!
-    Calls the indenter config file save as dialog to save the config file under a chosen name.
+    \brief Calls the indenter config file save as dialog to save the config file under a chosen name.
+
     If the file already exists and it should be overwritten, a warning is shown before.
  */
 void MainWindow::saveasIndentCfgFileDialog() {
@@ -548,7 +555,8 @@
 
 
 /*!
-    Shows a file open dialog to open an existing config file for the currently selected indenter.
+    \brief Shows a file open dialog to open an existing config file for the currently selected indenter.
+
     If the file was successfully opened the indent handler is called to load the settings and update itself.
  */
 void MainWindow::openConfigFileDialog() {
@@ -563,6 +571,8 @@
 
 
 /*!
+    \brief Shows a file open dialog.
+
     Shows a file open dialog with the title \a dialogHeaderStr starting in the directory \a startPath
     and with a file mask defined by \a fileMaskStr. Returns the contents of the file as QString.
  */
@@ -581,6 +591,8 @@
 
 
 /*!
+    \brief Updates the displaying of the source code.
+
     Updates the text edit field, which is showing the loaded, and if preview is enabled formatted, source code.
     Reassigns the line numbers and in case of switch between preview and none preview keeps the text field
     at the same line number.
@@ -610,7 +622,8 @@
 
 
 /*!
-    Calls the selected indenter with the currently loaded source code to retrieve the formatted source code.
+    \brief Calls the selected indenter with the currently loaded source code to retrieve the formatted source code.
+
     The original loaded source code file will not be changed.
  */
 void MainWindow::callIndenter() {
@@ -622,7 +635,7 @@
 
 
 /*!
-    Switches the syntax highlighting corresponding to the value \a turnOn either on or off.
+    \brief Switches the syntax highlighting corresponding to the value \a turnOn either on or off.
  */
 void MainWindow::turnHighlightOnOff(bool turnOn) {
     if ( turnOn ) {
@@ -637,7 +650,7 @@
 
 
 /*!
-    Added this slot to avoid multiple calls because of changed text.
+    \brief Added this slot to avoid multiple calls because of changed text.
  */
 void MainWindow::sourceCodeChangedHelperSlot() {
 	QTimer::singleShot(0, this, SLOT(sourceCodeChangedSlot()));
@@ -645,7 +658,7 @@
 
 
 /*!
-    Is emitted whenever the text inside the source view window changes. Calls the indenter
+    \brief Is emitted whenever the text inside the source view window changes. Calls the indenter
     to format the changed source code.
  */
 void MainWindow::sourceCodeChangedSlot() {
@@ -770,7 +783,8 @@
 
 
 /*!
-    This slot is called whenever one of the indenter settings are changed.
+    \brief This slot is called whenever one of the indenter settings are changed.
+
     It calls the selected indenter if the preview is turned on. If preview
     is not active a flag is set, that the settings have changed.
  */
@@ -813,7 +827,8 @@
 
 
 /*!
-    This slot is called whenever the preview button is turned on or off.
+    \brief This slot is called whenever the preview button is turned on or off.
+
     It calls the selected indenter to format the current source code if
     the code has been changed since the last indenter call.
  */
@@ -851,7 +866,7 @@
 
 
 /*!
-    This slot updates the main window title to show the currently opened
+    \brief This slot updates the main window title to show the currently opened
     source code filename.
  */
 void MainWindow::updateWindowTitle() {
@@ -860,7 +875,7 @@
 
 
 /*!
-    Opens a dialog to save the current source code as a PDF document.
+    \brief Opens a dialog to save the current source code as a PDF document.
  */
 void MainWindow::exportToPDF() {
     QString fileExtensions = tr("PDF Document")+" (*.pdf)";
@@ -882,7 +897,7 @@
 
 
 /*!
-    Opens a dialog to save the current source code as a HTML document.
+    \brief Opens a dialog to save the current source code as a HTML document.
  */
 void MainWindow::exportToHTML() {
 	QString fileExtensions = tr("HTML Document")+" (*.html)";
@@ -906,8 +921,9 @@
 
 
 /*!
-    Loads the last opened file if this option is enabled in the settings. If the file
-    does not exist, the default example file is tried to be loaded. If even that
+    \brief Loads the last opened file if this option is enabled in the settings. 
+    
+    If the file does not exist, the default example file is tried to be loaded. If even that
     fails a very small code example is shown.
     If the setting for opening the last file is disabled, the editor is empty on startup.
 */
@@ -953,7 +969,8 @@
 
 
 /*!
-    Saves the settings for the main application to the file "UniversalIndentGUI.ini".
+    \brief Saves the settings for the main application to the file "UniversalIndentGUI.ini".
+
     Settings are for example last selected indenter, last loaded config file and so on.
 */
 void MainWindow::saveSettings() {
@@ -985,7 +1002,7 @@
 
 
 /*!
-    Is always called when the program is quit. Calls the saveSettings function before really quits.
+    \brief Is always called when the program is quit. Calls the saveSettings function before really quits.
 */
 void MainWindow::closeEvent( QCloseEvent *event ) {
     if ( maybeSave() ) {
@@ -999,10 +1016,11 @@
 
 
 /*!
-    This function is setup to capture tooltip events. All widgets that are created by the
-    indentHandler object and are responsible for indenter parameters are connected with
-    this event filter. So depending on the settings the tooltips can be enabled and
-    disabled for these widgets.
+    \brief This function is setup to capture tooltip events. 
+    
+    All widgets that are created by the indentHandler object and are responsible 
+    for indenter parameters are connected with this event filter. 
+    So depending on the settings the tooltips can be enabled and disabled for these widgets.
  */
 bool MainWindow::eventFilter(QObject *obj, QEvent *event)
 {
@@ -1022,7 +1040,7 @@
 
 
 /*!
-    Is called at application exit and asks whether to save the source code file, if it has been changed.
+    \brief Is called at application exit and asks whether to save the source code file, if it has been changed.
  */
 bool MainWindow::maybeSave()
 {
@@ -1045,7 +1063,7 @@
 
 
 /*!
-    This slot is called whenever a language is selected in the menu. It tries to find the
+    \brief This slot is called whenever a language is selected in the menu. It tries to find the
     corresponding action in the languageInfoList and sets the language.
  */
 void MainWindow::languageChanged(int languageIndex) {
@@ -1073,7 +1091,7 @@
 
 
 /*!
-    Creates a menu entry under the settings menu for all available text encodings.
+    \brief Creates a menu entry under the settings menu for all available text encodings.
 */
 void MainWindow::createEncodingMenu() {
     QAction *encodingAction;
@@ -1104,7 +1122,7 @@
 
 
 /*!
-    This slot is called whenever an encoding is selected in the settings menu.
+    \brief This slot is called whenever an encoding is selected in the settings menu.
 */
 void MainWindow::encodingChanged(QAction* encodingAction) {
     if ( maybeSave() ) {
@@ -1131,7 +1149,7 @@
 
 
 /*!
-	Creates a menu entry under the settings menu for all available text encodings.
+	\brief Creates a menu entry under the settings menu for all available text encodings.
 */
 void MainWindow::createHighlighterMenu() {
 	QAction *highlighterAction;
@@ -1153,7 +1171,7 @@
 
 
 /*!
-    This slot handles signals coming from selecting another syntax highlighter.
+    \brief This slot handles signals coming from selecting another syntax highlighter.
  */
 void MainWindow::highlighterChanged(QAction* highlighterAction) {
 	QString highlighterName = highlighterAction->text();
@@ -1162,14 +1180,11 @@
     // Need to do this "text update" to update the syntax highlighting. Otherwise highlighting is wrong.
     previewToggled = true;
     updateSourceView();
-
-    
-    
 }
 
 
 /*!
-	Is called whenever the white space visibility is being changed in the menu.
+	\brief Is called whenever the white space visibility is being changed in the menu.
  */
 void MainWindow::setWhiteSpaceVisibility(bool visible) {
 	if ( visible ) {
@@ -1181,7 +1196,7 @@
 }
 
 /*!
-	This slot is called whenever the number of lines in the editor changes
+	\brief This slot is called whenever the number of lines in the editor changes
 	and adapts the margin for the displayed line numbers.
 */
 void MainWindow::numberOfLinesChanged() {
@@ -1192,7 +1207,7 @@
 
 
 /*!
-    Catches language change events and retranslates all needed widgets.
+    \brief Catches language change events and retranslates all needed widgets.
  */
 void MainWindow::changeEvent(QEvent *event) {
     if (event->type() == QEvent::LanguageChange) {
@@ -1227,6 +1242,8 @@
 
 
 /*!
+    \brief Invokes the indenter to create a shell script.
+
     Lets the indenter create a shell script for calling the indenter out of any
     other application and open a save dialog for saving the shell script.
  */
@@ -1262,10 +1279,12 @@
 
 
 /*!
-    Updates the list of recently opened files. Therefore the currently open file
-    is set at the lists first position regarding the in the settings set maximum
-    list length. Overheads of the list will be cut off. The new list will be
-    updated to the settings and the recently opened menu will be updated too.
+    \brief Updates the list of recently opened files. 
+    
+    Therefore the currently open file is set at the lists first position 
+    regarding the in the settings set maximum list length. Overheads of the 
+    list will be cut off. The new list will be updated to the settings and 
+    the recently opened menu will be updated too.
  */
 void MainWindow::updateRecentlyOpenedList() {
 
@@ -1334,7 +1353,7 @@
 
 
 /*!
-    This slot is called if an entry from the list of recently opened files is
+    \brief This slot is called if an entry from the list of recently opened files is
     being selected.
  */
 void MainWindow::openFileFromRecentlyOpenedList(QAction* recentlyOpenedAction) {
--- a/src/uiguisettings.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/uiguisettings.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -19,13 +19,16 @@
 
 #include "uiguisettings.h"
 
+//! \defgroup grp_Settings All concerning the settings.
+
 /*!
 	\class UiGuiSettings
+    \ingroup grp_Settings
 	\brief Handles the settings of the program. Reads them on startup and saves them on exit.
 */
 
 /*!
-	The constructor for the settings.
+	\brief The constructor for the settings.
 */
 UiGuiSettings::UiGuiSettings(QString settingFilePath) : QObject() {
     qsettings = new QSettings(settingFilePath, QSettings::IniFormat, this);
@@ -36,7 +39,7 @@
 
 
 /*!
-    The destructor saves the settings to a file.
+    \brief The destructor saves the settings to a file.
  */
 UiGuiSettings::~UiGuiSettings() {
 	//FIXME: Is never called!!
@@ -45,7 +48,8 @@
 
 
 /*!
-	Scans the translations directory for available translation files and stores them in the QList \a availableTranslations.
+	\brief Scans the translations directory for available translation files and 
+    stores them in the QList \a availableTranslations.
  */
 void UiGuiSettings::readAvailableTranslations() {
 	QString languageShort;
@@ -72,7 +76,7 @@
 
 
 /*!
-	Returns a list of the mnemonics of the available translations.
+	\brief Returns a list of the mnemonics of the available translations.
  */
 QStringList UiGuiSettings::getAvailableTranslations() {
 	return availableTranslations;
@@ -80,7 +84,8 @@
 
 
 /*!
-    Extern widgets can connect to this slot to change settings. 
+    \brief Extern widgets can connect to this slot to change settings.
+
     According to the objects name the corresponding setting is known and set.
  */
 void UiGuiSettings::handleValueChangeFromExtern(int value) {
@@ -96,7 +101,8 @@
 
 
 /*!
-    Extern widgets can connect to this slot to change settings. 
+    \brief Extern widgets can connect to this slot to change settings. 
+
     According to the objects name the corresponding setting is known and set.
  */
 void UiGuiSettings::handleValueChangeFromExtern(bool value) {
@@ -111,7 +117,8 @@
 }
 
 /*!
-    Extern widgets can connect to this slot to change settings. 
+    \brief Extern widgets can connect to this slot to change settings. 
+
     According to the objects name the corresponding setting is known and set.
 */
 void UiGuiSettings::handleValueChangeFromExtern(QDate value) {
@@ -127,7 +134,8 @@
 
 
 /*!
-    Extern widgets can connect to this slot to change settings. 
+    \brief Extern widgets can connect to this slot to change settings. 
+
     According to the objects name the corresponding setting is known and set.
 */
 void UiGuiSettings::handleValueChangeFromExtern(QByteArray value) {
@@ -143,7 +151,8 @@
 
 
 /*!
-	Sets the value of the by \a settingsName defined setting to the value \a value.
+	\brief Sets the value of the by \a settingsName defined setting to the value \a value.
+
     The to \a settingsName corresponding signal is emitted, if the value has changed.
  */
 bool UiGuiSettings::setValueByName(QString settingName, QVariant value) {
@@ -163,8 +172,9 @@
 
 
 /*!
-    Emits the correct signal for the given \a settingName. If \a settingName
-    equals "all", all signals are emitted. This can be used to update all
+    \brief Emits the correct signal for the given \a settingName. 
+    
+    If \a settingName equals "all", all signals are emitted. This can be used to update all
     dependent widgets. \a value is the new value that is emitted along with the signal.
  */
 void UiGuiSettings::emitSignalForSetting(QString settingName) {
@@ -209,7 +219,7 @@
 
 
 /*!
-    Calls \sa emitSignalForSetting with settingName "all" to update all widgets or whatever
+    \brief Calls \sa emitSignalForSetting with settingName "all" to update all widgets or whatever
     is connected to each setting.
  */
 void UiGuiSettings::updateAllDependend() {
@@ -218,7 +228,8 @@
 
 
 /*!
-	Returns the value of the by \a settingsName defined setting as QVariant. 
+	\brief Returns the value of the by \a settingsName defined setting as QVariant. 
+
 	If the named setting does not exist, 0 is being returned.
 */
 QVariant UiGuiSettings::getValueByName(QString settingName) {
@@ -231,7 +242,8 @@
 
 
 /*!
-    Loads the settings for the main application.
+    \brief Loads the settings for the main application.
+
 	Settings are for example last selected indenter, last loaded source code file and so on.
 */
 bool UiGuiSettings::loadSettings() {
@@ -289,7 +301,8 @@
 
 
 /*!
-    Saves the settings for the main application.
+    \brief Saves the settings for the main application.
+
     Settings are for example last selected indenter, last loaded source code file and so on.
 */
 bool UiGuiSettings::saveSettings() {
--- a/src/uiguisettingsdialog.cpp	Tue Aug 21 10:41:11 2007 +0000
+++ b/src/uiguisettingsdialog.cpp	Tue Aug 21 10:42:04 2007 +0000
@@ -21,11 +21,12 @@
 
 /*!
 	\class UiGuiSettingsDialog
+    \ingroup grp_Settings
 	\brief Displays a dialog window with settings for UniversalIndentGUI
 */
 
 /*!
-	The constructor calls the setup function for the ui created by uic. and adds
+	\brief The constructor calls the setup function for the ui created by uic. and adds
 */
 UiGuiSettingsDialog::UiGuiSettingsDialog(QWidget* parent, UiGuiSettings* settings) : QDialog(parent)
 {
@@ -54,8 +55,10 @@
 }
 
 /*!
-	By calling this function the combobox for selecting the application language will
-	be initialized. Also the translation itself will be reinitialized.
+	\brief By calling this function the combobox for selecting the application language will
+	be initialized. 
+    
+    Also the translation itself will be reinitialized.
  */
 void UiGuiSettingsDialog::initTranslationSelection() {
 	// First empty the combo box.
@@ -84,8 +87,9 @@
 
 
 /*!
-    Displays the dialog by calling the dialogs exec function. Before it
-    gets all the values needed from the UiGuiSettings object.
+    \brief Displays the dialog by calling the dialogs exec function. 
+    
+    Before it gets all the values needed from the UiGuiSettings object.
  */
 int UiGuiSettingsDialog::showDialog() {
     // Get the values for the check boxes from the settings object.
@@ -127,7 +131,8 @@
 
 
 /*!
-    This slot is called when the dialog box is closed by pressing the Ok button.
+    \brief This slot is called when the dialog box is closed by pressing the Ok button.
+
     Writes all settings to the UiGuiSettings object.
  */
 void UiGuiSettingsDialog::handleAccepted() {
@@ -164,7 +169,7 @@
 
 
 /*!
-    Catches language change events and retranslates all needed widgets.
+    \brief Catches language change events and retranslates all needed widgets.
  */
 void UiGuiSettingsDialog::changeEvent(QEvent *event) {
     if (event->type() == QEvent::LanguageChange) {