Commit 0e89104b authored by Friedemann Kleint's avatar Friedemann Kleint
Browse files

API Documentation: Fix warnings.

parent 66780b84
...@@ -1177,8 +1177,8 @@ void PluginManagerPrivate::profilingReport(const char *what, const PluginSpec *s ...@@ -1177,8 +1177,8 @@ void PluginManagerPrivate::profilingReport(const char *what, const PluginSpec *s
} }
/*! /*!
\fn void PluginManager::getObjectByName() \fn void PluginManager::getObjectByName(const QString &name) const
Retrieves one object with a given name from the object pool. \brief Retrieves one object with a given name from the object pool.
\sa addObject() \sa addObject()
*/ */
...@@ -1194,7 +1194,7 @@ QObject *PluginManager::getObjectByName(const QString &name) const ...@@ -1194,7 +1194,7 @@ QObject *PluginManager::getObjectByName(const QString &name) const
} }
/*! /*!
\fn void PluginManager::getObjectByClassName() \fn void PluginManager::getObjectByClassName(const QString &className) const
Retrieves one object inheriting a class with a given name from the object pool. Retrieves one object inheriting a class with a given name from the object pool.
\sa addObject() \sa addObject()
*/ */
......
...@@ -158,7 +158,7 @@ uint ExtensionSystem::qHash(const ExtensionSystem::PluginDependency &value) ...@@ -158,7 +158,7 @@ uint ExtensionSystem::qHash(const ExtensionSystem::PluginDependency &value)
} }
/*! /*!
\fn bool PluginDependency::operator==(const PluginDependency &other) \fn bool PluginDependency::operator==(const PluginDependency &other) const
\internal \internal
*/ */
bool PluginDependency::operator==(const PluginDependency &other) const bool PluginDependency::operator==(const PluginDependency &other) const
......
...@@ -53,7 +53,7 @@ enum { winExceptionCppException = 0xe06d7363, ...@@ -53,7 +53,7 @@ enum { winExceptionCppException = 0xe06d7363,
typedef ExtensionContext::StopReasonMap StopReasonMap; typedef ExtensionContext::StopReasonMap StopReasonMap;
/*! /*!
\class IDebugEventCallbacks \class EventCallback
Event handler wrapping the original IDebugEventCallbacks Event handler wrapping the original IDebugEventCallbacks
to catch and store exceptions (report crashes as stop reasons). to catch and store exceptions (report crashes as stop reasons).
......
...@@ -64,6 +64,7 @@ ...@@ -64,6 +64,7 @@
\o Hook up with output/event callbacks and produce formatted output \o Hook up with output/event callbacks and produce formatted output
\o Provide some extension commands that produce output in a standardized (GDBMI) \o Provide some extension commands that produce output in a standardized (GDBMI)
format that ends up in handleExtensionMessage(). format that ends up in handleExtensionMessage().
\endlist
*/ */
// Data struct and helpers for formatting help // Data struct and helpers for formatting help
......
...@@ -239,8 +239,8 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) ...@@ -239,8 +239,8 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err)
If \a abortOnMeta is \c true, cmd shell semantics are applied before If \a abortOnMeta is \c true, cmd shell semantics are applied before
proceeding with word splitting: proceeding with word splitting:
\list \list
\i Cmd ignores \em all special chars between double quotes. \i Cmd ignores \e all special chars between double quotes.
Note that the quotes are \em not removed at this stage - the Note that the quotes are \e not removed at this stage - the
tokenization rules described above still apply. tokenization rules described above still apply.
\i The \c circumflex is the escape char for everything including itself. \i The \c circumflex is the escape char for everything including itself.
\endlist \endlist
...@@ -251,7 +251,7 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err) ...@@ -251,7 +251,7 @@ static QStringList doSplitArgs(const QString &args, QtcProcess::SplitError *err)
\param cmd the command to split \param cmd the command to split
\param abortOnMeta see above \param abortOnMeta see above
\param err if not NULL, a status code will be stored at the pointer \param err if not NULL, a status code will be stored at the pointer
target, see \ref SplitError target, see \l SplitError
\param env if not NULL, perform variable substitution with the \param env if not NULL, perform variable substitution with the
given environment. given environment.
\return a list of unquoted words or an empty list if an error occurred \return a list of unquoted words or an empty list if an error occurred
......
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
#include <QtCore/QTimer> #include <QtCore/QTimer>
/*! /*!
\class SshRemoteProcess \class Utils::SshRemoteProcess
\brief This class implements an SSH channel for running a remote process. \brief This class implements an SSH channel for running a remote process.
......
...@@ -146,7 +146,7 @@ namespace { ...@@ -146,7 +146,7 @@ namespace {
*/ */
/*! /*!
\fn ActionContainer *ActionManager::createMenu(const QString &id) \fn ActionContainer *ActionManager::createMenu(const Id &id)
\brief Creates a new menu with the given string \a id. \brief Creates a new menu with the given string \a id.
Returns a new ActionContainer that you can use to get the QMenu instance Returns a new ActionContainer that you can use to get the QMenu instance
...@@ -157,7 +157,7 @@ namespace { ...@@ -157,7 +157,7 @@ namespace {
*/ */
/*! /*!
\fn ActionContainer *ActionManager::createMenuBar(const QString &id) \fn ActionContainer *ActionManager::createMenuBar(const Id &id)
\brief Creates a new menu bar with the given string \a id. \brief Creates a new menu bar with the given string \a id.
Returns a new ActionContainer that you can use to get the QMenuBar instance Returns a new ActionContainer that you can use to get the QMenuBar instance
...@@ -166,7 +166,7 @@ namespace { ...@@ -166,7 +166,7 @@ namespace {
*/ */
/*! /*!
\fn Command *ActionManager::registerAction(QAction *action, const QString &id, const Context &context, bool scriptable) \fn Command *ActionManager::registerAction(QAction *action, const Id &id, const Context &context, bool scriptable)
\brief Makes an \a action known to the system under the specified string \a id. \brief Makes an \a action known to the system under the specified string \a id.
Returns a command object that represents the action in the application and is Returns a command object that represents the action in the application and is
...@@ -192,7 +192,7 @@ namespace { ...@@ -192,7 +192,7 @@ namespace {
*/ */
/*! /*!
\fn Command *ActionManager::command(const QString &id) const \fn Command *ActionManager::command(const Id &id) const
\brief Returns the Command object that is known to the system \brief Returns the Command object that is known to the system
under the given string \a id. under the given string \a id.
...@@ -200,7 +200,7 @@ namespace { ...@@ -200,7 +200,7 @@ namespace {
*/ */
/*! /*!
\fn ActionContainer *ActionManager::actionContainer(const QString &id) const \fn ActionContainer *ActionManager::actionContainer(const Id &id) const
\brief Returns the IActionContainter object that is know to the system \brief Returns the IActionContainter object that is know to the system
under the given string \a id. under the given string \a id.
...@@ -209,7 +209,7 @@ namespace { ...@@ -209,7 +209,7 @@ namespace {
*/ */
/*! /*!
\fn Command *ActionManager::unregisterAction(QAction *action, const QString &id) \fn Command *ActionManager::unregisterAction(QAction *action, const Id &id)
\brief Removes the knowledge about an \a action under the specified string \a id. \brief Removes the knowledge about an \a action under the specified string \a id.
Usually you do not need to unregister actions. The only valid use case for unregistering Usually you do not need to unregister actions. The only valid use case for unregistering
......
...@@ -106,7 +106,7 @@ ...@@ -106,7 +106,7 @@
*/ */
/*! /*!
\fn QString IWizard::name() const \fn QString IWizard::displayName() const
Returns the translated name of the wizard, how it should appear in the Returns the translated name of the wizard, how it should appear in the
dialog. dialog.
*/ */
......
...@@ -56,11 +56,6 @@ ...@@ -56,11 +56,6 @@
Returns the mime type the editor supports Returns the mime type the editor supports
*/ */
/*!
\fn QString IExternalEditor::kind() const
Returns the editor kind (identifying string).
*/
/*! /*!
\fn bool IExternalEditor::startEditor(const QString &fileName, QString *errorMessage) = 0; \fn bool IExternalEditor::startEditor(const QString &fileName, QString *errorMessage) = 0;
......
...@@ -306,7 +306,7 @@ void FileManager::dump() ...@@ -306,7 +306,7 @@ void FileManager::dump()
} }
/*! /*!
\fn void FileManager::renamedFile(const QString &from, QString &to) \fn void FileManager::renamedFile(const QString &from, const QString &to)
\brief Tells the file manager that a file has been renamed on disk from within Qt Creator. \brief Tells the file manager that a file has been renamed on disk from within Qt Creator.
Needs to be called right after the actual renaming on disk (i.e. before the file system Needs to be called right after the actual renaming on disk (i.e. before the file system
...@@ -703,7 +703,7 @@ QString FileManager::getSaveFileNameWithExtension(const QString &title, const QS ...@@ -703,7 +703,7 @@ QString FileManager::getSaveFileNameWithExtension(const QString &title, const QS
} }
/*! /*!
\fn QString FileManager::getSaveAsFileName(IFile *file) \fn QString FileManager::getSaveAsFileName(IFile *file, const QString &filter, QString *selectedFilter)
Asks the user for a new file name (Save File As) for /arg file. Asks the user for a new file name (Save File As) for /arg file.
*/ */
...@@ -739,7 +739,9 @@ QString FileManager::getSaveAsFileName(IFile *file, const QString &filter, QStri ...@@ -739,7 +739,9 @@ QString FileManager::getSaveAsFileName(IFile *file, const QString &filter, QStri
} }
/*! /*!
\fn QString FileManager::getOpenFileNames(const QString &filters, const QString &pathIn, QString *selectedFilter) const \fn QStringList FileManager::getOpenFileNames(const QString &filters,
const QString pathIn,
QString *selectedFilter)
Asks the user for a set of file names to be opened. The \a filters Asks the user for a set of file names to be opened. The \a filters
and \a selectedFilter parameters is interpreted like in and \a selectedFilter parameters is interpreted like in
...@@ -1038,7 +1040,7 @@ void FileManager::syncWithEditor(Core::IContext *context) ...@@ -1038,7 +1040,7 @@ void FileManager::syncWithEditor(Core::IContext *context)
} }
/*! /*!
\fn void FileManager::addToRecentFiles(const QString &fileName, , const QString &editorId) \fn void FileManager::addToRecentFiles(const QString &fileName, const QString &editorId)
Adds the \a fileName to the list of recent files. Associates the file to Adds the \a fileName to the list of recent files. Associates the file to
be reopened with an editor of the given \a editorId, if possible. be reopened with an editor of the given \a editorId, if possible.
......
...@@ -73,7 +73,8 @@ ...@@ -73,7 +73,8 @@
/*! /*!
\fn bool ICore::showOptionsDialog(const QString &group = QString(), \fn bool ICore::showOptionsDialog(const QString &group = QString(),
const QString &page = QString()) const QString &page = QString(),
QWidget *parent = 0)
\brief Opens the application options/preferences dialog with preselected \brief Opens the application options/preferences dialog with preselected
\a page in a specified \a group. \a page in a specified \a group.
...@@ -124,14 +125,6 @@ ...@@ -124,14 +125,6 @@
general application debug messages. general application debug messages.
*/ */
/*!
\fn ExtensionSystem::PluginManager *ICore::pluginManager() const
\brief Returns the application's plugin manager.
The plugin manager handles the plugin life cycles and manages
the common object pool.
*/
/*! /*!
\fn EditorManager *ICore::editorManager() const \fn EditorManager *ICore::editorManager() const
\brief Returns the application's editor manager. \brief Returns the application's editor manager.
...@@ -192,7 +185,7 @@ ...@@ -192,7 +185,7 @@
*/ */
/*! /*!
\fn QSettings *ICore::settings(QSettings::UserScope scope) const \fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope) const
\brief Returns the application's main settings object. \brief Returns the application's main settings object.
You can use it to retrieve or set application wide settings You can use it to retrieve or set application wide settings
...@@ -263,7 +256,7 @@ ...@@ -263,7 +256,7 @@
*/ */
/*! /*!
\fn void ICore::updateAdditionalContexts(const Core::Context &remove, const Core::Context &add) \fn void ICore::updateAdditionalContexts(const Context &remove, const Context &add)
\brief Change the currently active additional contexts. \brief Change the currently active additional contexts.
Removes the list of additional contexts specified by \a remove and adds the Removes the list of additional contexts specified by \a remove and adds the
...@@ -303,7 +296,7 @@ ...@@ -303,7 +296,7 @@
*/ */
/*! /*!
\fn void ICore::openFiles(const QStringList &fileNames) \fn void ICore::openFiles(const QStringList &fileNames, OpenFilesFlags flags = None)
\brief Open all files from a list of \a fileNames like it would be \brief Open all files from a list of \a fileNames like it would be
done if they were given to Qt Creator on the command line, or done if they were given to Qt Creator on the command line, or
they were opened via \gui{File|Open}. they were opened via \gui{File|Open}.
......
...@@ -523,8 +523,7 @@ static inline bool canUseEngine(DebuggerEngineType et, ...@@ -523,8 +523,7 @@ static inline bool canUseEngine(DebuggerEngineType et,
} }
/*! /*!
\fn ConfigurationCheck checkDebugConfiguration(unsigned cmdLineEnabledEngines, \fn Debugger::ConfigurationCheck Debugger::checkDebugConfiguration(const DebuggerStartParameters &sp)
const DebuggerStartParameters &sp)
This is the master engine detection function that returns the This is the master engine detection function that returns the
engine types for a given set of start parameters and checks their engine types for a given set of start parameters and checks their
......
...@@ -73,7 +73,7 @@ typedef QPair<QString, QString> Mapping; ...@@ -73,7 +73,7 @@ typedef QPair<QString, QString> Mapping;
typedef DebuggerSourcePathMappingWidget::SourcePathMap SourcePathMap; typedef DebuggerSourcePathMappingWidget::SourcePathMap SourcePathMap;
/*! /*!
\class SourcePathMappingModel \class Debugger::Internal::SourcePathMappingModel
\brief Model for DebuggerSourcePathMappingWidget. \brief Model for DebuggerSourcePathMappingWidget.
...@@ -194,7 +194,7 @@ void SourcePathMappingModel::setTarget(int row, const QString &t) ...@@ -194,7 +194,7 @@ void SourcePathMappingModel::setTarget(int row, const QString &t)
} }
/*! /*!
\class DebuggerSourcePathMappingWidget \class Debugger::Internal::DebuggerSourcePathMappingWidget
\brief Widget for maintaining a set of source path mappings for the debugger. \brief Widget for maintaining a set of source path mappings for the debugger.
......
...@@ -443,7 +443,7 @@ private: ...@@ -443,7 +443,7 @@ private:
}; };
/*! /*!
\class PinnableToolTipWidget \class Debugger::Internal::PinnableToolTipWidget
A pinnable tooltip that goes from State 'Unpinned' (button showing A pinnable tooltip that goes from State 'Unpinned' (button showing
'Pin') to 'Pinned' (button showing 'Close'). 'Pin') to 'Pinned' (button showing 'Close').
...@@ -572,7 +572,7 @@ void DraggableLabel::mouseMoveEvent(QMouseEvent * event) ...@@ -572,7 +572,7 @@ void DraggableLabel::mouseMoveEvent(QMouseEvent * event)
} }
/*! /*!
\class DebuggerToolTipContext \class Debugger::Internal::DebuggerToolTipContext
File name and position where the tooltip is anchored. Redundant position/line column File name and position where the tooltip is anchored. Redundant position/line column
information is used to detect if the underlying file has been changed information is used to detect if the underlying file has been changed
...@@ -606,7 +606,7 @@ QDebug operator<<(QDebug d, const DebuggerToolTipContext &c) ...@@ -606,7 +606,7 @@ QDebug operator<<(QDebug d, const DebuggerToolTipContext &c)
} }
/*! /*!
\class AbstractDebuggerToolTipWidget \class Debugger::Internal::AbstractDebuggerToolTipWidget
Base class for a tool tip widget associated with file name Base class for a tool tip widget associated with file name
and position with functionality to and position with functionality to
...@@ -890,7 +890,7 @@ bool DebuggerToolTipExpressionFilterModel::filterAcceptsRow(int sourceRow, const ...@@ -890,7 +890,7 @@ bool DebuggerToolTipExpressionFilterModel::filterAcceptsRow(int sourceRow, const
} }
/*! /*!
\class DebuggerToolTipTreeView \class Debugger::Internal::DebuggerToolTipTreeView
A treeview that adapts its size to the model contents (also while expanding) A treeview that adapts its size to the model contents (also while expanding)
to be used within DebuggerTreeViewToolTipWidget. to be used within DebuggerTreeViewToolTipWidget.
...@@ -987,7 +987,7 @@ void DebuggerToolTipTreeView::computeSize() ...@@ -987,7 +987,7 @@ void DebuggerToolTipTreeView::computeSize()
} }
/*! /*!
\class DebuggerTreeViewToolTipWidget \class Debugger::Internal::DebuggerTreeViewToolTipWidget
Tool tip widget for tree views with functionality to save/restore tree Tool tip widget for tree views with functionality to save/restore tree
model contents to XML. model contents to XML.
...@@ -1124,7 +1124,7 @@ QString DebuggerTreeViewToolTipWidget::clipboardContents() const ...@@ -1124,7 +1124,7 @@ QString DebuggerTreeViewToolTipWidget::clipboardContents() const
} }
/*! /*!
\class DebuggerToolTipManager \class Debugger::Internal::DebuggerToolTipManager
Manages the pinned tooltip widgets, listens on editor scroll and main window move Manages the pinned tooltip widgets, listens on editor scroll and main window move
events and takes care of repositioning the tooltips. events and takes care of repositioning the tooltips.
......
...@@ -622,7 +622,7 @@ void SearchResultWindow::setTextEditorFont(const QFont &font) ...@@ -622,7 +622,7 @@ void SearchResultWindow::setTextEditorFont(const QFont &font)
} }
/*! /*!
\fn void SearchResultWindow::handleJumpToSearchResult(int index, bool) \fn void SearchResultWindow::handleJumpToSearchResult(const SearchResultItem &item)
\internal \internal
*/ */
void SearchResultWindow::handleJumpToSearchResult(const SearchResultItem &item) void SearchResultWindow::handleJumpToSearchResult(const SearchResultItem &item)
...@@ -658,7 +658,7 @@ void SearchResultWindow::addResult(const QString &fileName, int lineNumber, cons ...@@ -658,7 +658,7 @@ void SearchResultWindow::addResult(const QString &fileName, int lineNumber, cons
} }
/*! /*!
\fn void SearchResultWindow::addResults(QList<SearchResultItem> &items) \fn void SearchResultWindow::addResults(QList<SearchResultItem> &items, AddMode mode)
\brief Adds all of the given search result \a items to the search \brief Adds all of the given search result \a items to the search
results window. results window.
......
...@@ -69,12 +69,12 @@ enum { debug = 0, debugRepositorySearch = 0, debugExecution = 0 }; ...@@ -69,12 +69,12 @@ enum { debug = 0, debugRepositorySearch = 0, debugExecution = 0 };
/*! /*!
\namespace VCSBase \namespace VCSBase
VCSBase plugin namespace \brief VCSBase plugin namespace
*/ */
/*! /*!
\namespace VCSBase::Internal \namespace VCSBase::Internal
Internal namespace of the VCSBase plugin \brief Internal namespace of the VCSBase plugin
\internal \internal
*/ */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment