Martchus
/
qtutilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation

This commit is contained in:
Martchus 2016-06-10 23:05:43 +02:00
parent 9e52a3ac1f
commit 9137a63462
5 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CMakeLists.txt
View File

@ -78,6 +78,10 @@ set(CMAKE_MODULE_FILES
cmake/modules/WebViewProviderConfig.cmake cmake/modules/WebViewProviderConfig.cmake
) )
set(DOC_FILES
README.md
)
# meta data # meta data
set(META_PROJECT_NAME qtutilities) set(META_PROJECT_NAME qtutilities)
set(META_PROJECT_VARNAME QT_UTILITIES) set(META_PROJECT_VARNAME QT_UTILITIES)
@ -87,7 +91,7 @@ set(META_APP_URL "https://github.com/${META_APP_AUTHOR}/${META_PROJECT_NAME}")
set(META_APP_DESCRIPTION "Common Qt related C++ classes and routines used by my applications such as dialogs, widgets and models.") set(META_APP_DESCRIPTION "Common Qt related C++ classes and routines used by my applications such as dialogs, widgets and models.")
set(META_VERSION_MAJOR 4) set(META_VERSION_MAJOR 4)
set(META_VERSION_MINOR 0) set(META_VERSION_MINOR 0)
set(META_VERSION_PATCH 0) set(META_VERSION_PATCH 1)
set(META_APP_VERSION ${META_VERSION_MAJOR}.${META_VERSION_MINOR}.${META_VERSION_PATCH}) set(META_APP_VERSION ${META_VERSION_MAJOR}.${META_VERSION_MINOR}.${META_VERSION_PATCH})
# required to include CMake modules from own project directory # required to include CMake modules from own project directory
@ -116,3 +120,4 @@ include(QtGuiConfig)
include(QtConfig) include(QtConfig)
include(WindowsResources) include(WindowsResources)
include(LibraryTarget) include(LibraryTarget)
include(Doxygen)

1
misc/recentmenumanager.cpp
View File

@ -18,6 +18,7 @@ namespace MiscUtils {
/*! /*!
* \brief Constructs a new recent menu manager. * \brief Constructs a new recent menu manager.
* \param menu Specifies the QMenu instance to operate with. * \param menu Specifies the QMenu instance to operate with.
* \param parent Specifies the parent QObject; might be nullptr.
* \remarks * \remarks
* - Menu title and icon are set within the constructor. * - Menu title and icon are set within the constructor.
* - The current menu entries are cleared. * - The current menu entries are cleared.

2
resources/resources.cpp
View File

@ -97,7 +97,7 @@ void loadApplicationTranslationFile(const QString &applicationName)
/*! /*!
* \brief Loads and installs the appropriate application translation file for the specified locale. * \brief Loads and installs the appropriate application translation file for the specified locale.
* \param applicationName Specifies the name of the application. * \param applicationName Specifies the name of the application.
* \param localName Specifies the name of the locale. * \param localeName Specifies the name of the locale.
* \remarks Translation files have to be placed in one of the following * \remarks Translation files have to be placed in one of the following
* locations: * locations:
* - ./translations * - ./translations

5
settingsdialog/optioncategorymodel.cpp
View File

@ -22,10 +22,9 @@ OptionCategoryModel::OptionCategoryModel(QObject *parent) :
/*! /*!
* \brief Constructs an option category model with the specified \a categories. * \brief Constructs an option category model with the specified \a categories.
* * \remarks The model takes ownership over the given categories.
* The model takes ownership over the given categories.
*/ */
OptionCategoryModel::OptionCategoryModel(const QList<Dialogs::OptionCategory *> &categories, QObject *parent) : OptionCategoryModel::OptionCategoryModel(const QList<OptionCategory *> &categories, QObject *parent) :
QAbstractListModel(parent), QAbstractListModel(parent),
m_categories(categories) m_categories(categories)
{ {

5
settingsdialog/optionpage.cpp
View File

@ -84,11 +84,6 @@ bool OptionPage::matches(const QString &searchKeyWord)
return false; return false;
} }
/*!
* \fn OptionPage::displayName()
* \brief Returns the display name of the page.
*/
/*! /*!
* \fn OptionPage::apply() * \fn OptionPage::apply()
* \brief Applies altered settings. * \brief Applies altered settings.