feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: fix function signatures in code documentation

Browse Source 
QDoc cannot find functions if the signature in the \fn command
is not identical to the declaration, including 'const' qualifiers.

Removed the \fn where the documentation comes immediately before the
function, as qdoc does not need it in that case.

Change-Id: If6a2a2e2d58b394905c803787d2a93489049e4ca
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-05-23 16:13:55 +02:00
parent c88d7be702
commit 26c412deac
23 changed files with 75 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/plugins/coreplugin/actionmanager/actioncontainer.cpp
View File

@@ -117,13 +117,13 @@ using namespace Core::Internal;
*/
/*!
\fn QAction *ActionContainer::insertLocation(const Core::Id &group) const
\fn QAction *ActionContainer::insertLocation(const Id &group) const
Returns an action representing the \a group,
that could be used with \c{QWidget::insertAction}.
*/
/*!
\fn void ActionContainer::appendGroup(const QString &identifier)
\fn void ActionContainer::appendGroup(const Id &group)
Adds a group with the given \a identifier to the action container. Using groups
you can segment your action container into logical parts and add actions and
menus directly to these parts.
@@ -132,7 +132,7 @@ using namespace Core::Internal;
*/
/*!
\fn void ActionContainer::addAction(Core::Command *action, const Core::Id &group)
\fn void ActionContainer::addAction(Command *action, const Id &group = Id())
Add the \a action as a menu item to this action container. The action is added as the
last item of the specified \a group.
\sa appendGroup()
@@ -140,18 +140,13 @@ using namespace Core::Internal;
*/
/*!
\fn void ActionContainer::addMenu(Core::ActionContainer *menu, const Core::Id &group)
\fn void ActionContainer::addMenu(ActionContainer *menu, const Id &group = Id())
Add the \a menu as a submenu to this action container. The menu is added as the
last item of the specified \a group.
\sa appendGroup()
\sa addAction()
*/
/*!
\fn ActionContainer::~ActionContainer()
\internal
*/
// ---------- ActionContainerPrivate ------------
/*!
@@ -290,8 +285,6 @@ void ActionContainerPrivate::addMenu(ActionContainer *before, ActionContainer *m
}
/*!
* \fn Command *ActionContainer::addSeparator(const Context &context, const Id &group, QAction **outSeparator)
*
* Adds a separator to the end of the given \a group to the action container, which is enabled
* for a given \a context. The created separator action is returned through \a outSeparator.
*

5
src/plugins/coreplugin/actionmanager/command.cpp
View File

@@ -200,11 +200,6 @@
interact with it.
*/
/*!
\fn Command::~Command()
\internal
*/
using namespace Core;
using namespace Core::Internal;

3
src/plugins/coreplugin/basefilewizard.cpp
View File

@@ -559,8 +559,7 @@ Core::IWizard::WizardFlags BaseFileWizard::flags() const
/*!
\fn virtual QWizard *Core::BaseFileWizard::createWizardDialog(QWidget *parent,
const QString &defaultPath,
const WizardPageList &extensionPages) const = 0
const WizardDialogParameters &wizardDialogParameters) const
\brief Implement to create the wizard dialog on the parent, adding the extension pages.
*/

6
src/plugins/coreplugin/dialogs/iwizard.cpp
View File

@@ -128,7 +128,11 @@
*/
/*!
\fn void IWizard::runWizard(const QString &path, QWidget *parent)
\fn void IWizard::runWizard(const QString &path,
QWidget *parent,
const QString &platform,
const QVariantMap &variables)
This method is executed when the wizard has been selected by the user
for execution. Any dialogs the wizard opens should use the given \a parent.
The \a path argument is a suggestion for the location where files should be

30
src/plugins/coreplugin/documentmanager.cpp
View File

@@ -273,8 +273,6 @@ static void addFileInfo(IDocument *document)
}
/*!
\fn bool DocumentManager::addFiles(const QList<IDocument *> &documents, bool addWatcher)
Adds a list of IDocument's to the collection. If \a addWatcher is true (the default),
the files are added to a file system watcher that notifies the file manager
about file changes.
@@ -362,7 +360,6 @@ static void dump()
*/
/*!
\fn void DocumentManager::renamedFile(const QString &from, const QString &to)
\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
@@ -406,8 +403,6 @@ void DocumentManager::fileNameChanged(const QString &oldName, const QString &new
}
/*!
\fn bool DocumentManager::addFile(IDocument *document, bool addWatcher)
Adds a IDocument object to the collection. If \a addWatcher is true (the default),
the file is added to a file system watcher that notifies the file manager
about file changes.
@@ -426,8 +421,6 @@ void DocumentManager::documentDestroyed(QObject *obj)
}
/*!
\fn bool DocumentManager::removeFile(IDocument *document)
Removes a IDocument object from the collection.
Returns true if the file specified by \a document had the addWatcher argument to addDocument() set.
@@ -466,7 +459,6 @@ void DocumentManager::checkForNewFileName()
}
/*!
\fn QString DocumentManager::fixFileName(const QString &fileName, FixMode fixmode)
Returns a guaranteed cleaned path in native form. If the file exists,
it will either be a cleaned absolute file path (fixmode == KeepLinks), or
a cleaned canonical file path (fixmode == ResolveLinks).
@@ -490,8 +482,6 @@ QString DocumentManager::fixFileName(const QString &fileName, FixMode fixmode)
}
/*!
\fn QList<IDocument*> DocumentManager::modifiedFiles() const
Returns the list of IDocument's that have been modified.
*/
QList<IDocument *> DocumentManager::modifiedDocuments()
@@ -512,8 +502,6 @@ QList<IDocument *> DocumentManager::modifiedDocuments()
}
/*!
\fn void DocumentManager::expectFileChange(const QString &fileName)
Any subsequent change to \a fileName is treated as a expected file change.
\see DocumentManager::unexpectFileChange(const QString &fileName)
@@ -538,8 +526,6 @@ static void updateExpectedState(const QString &fileName)
}
/*!
\fn void DocumentManager::unexpectFileChange(const QString &fileName)
Any change to \a fileName are unexpected again.
\see DocumentManager::expectFileChange(const QString &fileName)
@@ -562,8 +548,6 @@ void DocumentManager::unexpectFileChange(const QString &fileName)
}
/*!
\fn QList<IDocument*> DocumentManager::saveModifiedFilesSilently(const QList<IDocument*> &documents)
Tries to save the files listed in \a documents. The \a cancelled argument is set to true
if the user cancelled the dialog. Returns the files that could not be saved. If the files
listed in documents have no write permissions an additional dialog will be prompted to
@@ -575,8 +559,6 @@ QList<IDocument *> DocumentManager::saveModifiedDocumentsSilently(const QList<ID
}
/*!
\fn QList<IDocument*> DocumentManager::saveModifiedFiles(const QList<IDocument *> &documents, bool *cancelled, const QString &message, const QString &alwaysSaveMessage, bool *alwaysSave)
Asks the user whether to save the files listed in \a documents .
Opens a dialog with the given \a message, and a additional
text that should be used to ask if the user wants to enabled automatic save
@@ -758,8 +740,6 @@ QString DocumentManager::getSaveFileNameWithExtension(const QString &title, cons
}
/*!
\fn QString DocumentManager::getSaveAsFileName(IDocument *document, const QString &filter, QString *selectedFilter)
Asks the user for a new file name (Save File As) for /arg document.
*/
QString DocumentManager::getSaveAsFileName(const IDocument *document, const QString &filter, QString *selectedFilter)
@@ -794,10 +774,6 @@ QString DocumentManager::getSaveAsFileName(const IDocument *document, const QStr
}
/*!
\fn QStringList DocumentManager::getOpenFileNames(const QString &filters,
const QString pathIn,
QString *selectedFilter)
Asks the user for a set of file names to be opened. The \a filters
and \a selectedFilter parameters is interpreted like in
QFileDialog::getOpenFileNames(), \a pathIn specifies a path to open the dialog
@@ -1078,8 +1054,6 @@ void DocumentManager::syncWithEditor(const QList<Core::IContext *> &context)
}
/*!
\fn void DocumentManager::addToRecentFiles(const QString &fileName, const QString &editorId)
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.
\a editorId defaults to the empty id, which means to let the system figure out
@@ -1103,8 +1077,6 @@ void DocumentManager::addToRecentFiles(const QString &fileName, const Id &editor
}
/*!
\fn void DocumentManager::clearRecentFiles()
Clears the list of recent files. Should only be called by
the core plugin when the user chooses to clear it.
*/
@@ -1114,8 +1086,6 @@ void DocumentManager::clearRecentFiles()
}
/*!
\fn QStringList DocumentManager::recentFiles() const
Returns the list of recent files.
*/
QList<DocumentManager::RecentFile> DocumentManager::recentFiles()

5
src/plugins/coreplugin/editormanager/iexternaleditor.cpp
View File

@@ -42,11 +42,6 @@
\internal
*/
/*!
\fn IExternalEditor::~IExternalEditor()
\internal
*/
/*!
\fn QStringList IExternalEditor::mimeTypes() const
Returns the mime type the editor supports

6
src/plugins/coreplugin/featureprovider.cpp
View File

@@ -60,7 +60,7 @@
*/
/*!
\fn FeatureProvider::Features availableFeatures() const;
\fn FetureSet IFeatureProvider::availableFeatures(const QString &platform) const
Returns available features provided by this manager.
\sa FeatureProvider::Features
*/
@@ -96,13 +96,13 @@
/*!
\fn bool Features::~contains(const Feature &feature)()
\fn bool FeatureSet::contains(const Feature &feature) const
\returns true if the \param features is available.
*/
/*!
\fn bool Features::~contains(const Features &features)()
\fn bool FeatureSet::contains(const FeatureSet &features) const
\returns true if all \param features are available.
*/

71
src/plugins/coreplugin/icore.cpp
View File

@@ -57,7 +57,8 @@
/*!
\fn void ICore::showNewItemDialog(const QString &title,
const QList<IWizard *> &wizards,
const QString &defaultLocation = QString())
const QString &defaultLocation = QString(),
const QVariantMap &extraVariables = QVariantMap())
\brief Opens a dialog where the user can choose from a set of \a wizards that
create new files/classes/projects.
@@ -70,9 +71,7 @@
*/
/*!
\fn bool ICore::showOptionsDialog(const QString &group = QString(),
const QString &page = QString(),
QWidget *parent = 0)
\fn bool ICore::showOptionsDialog(Id group, Id page, QWidget *parent = 0);
\brief Opens the application options/preferences dialog with preselected
\a page in a specified \a group.
@@ -82,9 +81,9 @@
/*!
\fn bool ICore::showWarningWithOptions(const QString &title, const QString &text,
const QString &details = QString(),
const QString &settingsCategory = QString(),
const QString &settingsId = QString(),
QWidget *parent = 0);
Id settingsCategory = Id(),
Id settingsId = Id(),
QWidget *parent = 0)
\brief Show a warning message with a button that opens a settings page.
@@ -94,22 +93,21 @@
/*!
\fn ActionManager *ICore::actionManager() const
\brief Returns the application's action manager.
\fn ActionManager *ICore::actionManager()
\obsolete
The action manager is responsible for registration of menus and
menu items and keyboard shortcuts.
Use \c ActionManager::actionManager() directly.
*/
/*!
\fn DocumentManager *ICore::fileManager() const
\brief Returns the application's file manager.
\fn DocumentManager *ICore::documentManager()
\obsolete
The file manager keeps track of files for changes outside the application.
Use \c DocumentManager::documentManager() directly.
*/
/*!
\fn MessageManager *ICore::messageManager() const
\fn MessageManager *ICore::messageManager()
\brief Returns the application's message manager.
The message manager is the interface to the "General" output pane for
@@ -117,7 +115,7 @@
*/
/*!
\fn EditorManager *ICore::editorManager() const
\fn EditorManager *ICore::editorManager()
\brief Returns the application's editor manager.
The editor manager handles all editor related tasks like opening
@@ -126,7 +124,7 @@
*/
/*!
\fn ProgressManager *ICore::progressManager() const
\fn ProgressManager *ICore::progressManager()
\brief Returns the application's progress manager.
Use the progress manager to register a concurrent task to
@@ -134,21 +132,19 @@
*/
/*!
\fn ScriptManager *ICore::scriptManager() const
\fn ScriptManager *ICore::scriptManager()
\internal
*/
/*!
\fn VariableManager *ICore::variableManager() const
\brief Returns the application's variable manager.
\fn VariableManager *ICore::variableManager()
\obsolete
The variable manager is used to register application wide string variables
like \c MY_PROJECT_DIR such that strings like \c{somecommand ${MY_PROJECT_DIR}/sub}
can be resolved/expanded from anywhere in the application.
Use \c VariableManager::variableManager() directly.
*/
/*!
\fn VcsManager *ICore::vcsManager() const
\fn VcsManager *ICore::vcsManager()
\brief Returns the application's vcs manager.
The vcs manager can be used to e.g. retrieve information about
@@ -159,24 +155,21 @@
*/
/*!
\fn ModeManager *ICore::modeManager() const
\brief Returns the application's mode manager.
\fn ModeManager *ICore::modeManager()
\obsolete
The mode manager handles everything related to the instances of IMode
that were added to the plugin manager's object pool as well as their
buttons and the tool bar with the round buttons in the lower left
corner of Qt Creator.
Use \c ModeManager::modeManager() directly.
*/
/*!
\fn MimeDatabase *ICore::mimeDatabase() const
\fn MimeDatabase *ICore::mimeDatabase()
\brief Returns the application's mime database.
Use the mime database to manage mime types.
*/
/*!
\fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope) const
\fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope)
\brief Returns the application's main settings object.
You can use it to retrieve or set application wide settings
@@ -194,7 +187,7 @@
*/
/*!
\fn SettingsDatabase *ICore::settingsDatabase() const
\fn SettingsDatabase *ICore::settingsDatabase()
\brief Returns the application's settings database.
The settings database is meant as an alternative to the regular settings
@@ -205,7 +198,7 @@
*/
/*!
\fn QPrinter *ICore::printer() const
\fn QPrinter *ICore::printer()
\brief Returns the application's printer object.
Always use this printer object for printing, so the different parts of the
@@ -213,7 +206,7 @@
*/
/*!
\fn QString ICore::resourcePath() const
\fn QString ICore::resourcePath()
\brief Returns the absolute path that is used for resources like
project templates and the debugger macros.
@@ -223,7 +216,7 @@
/*!
\fn QString ICore::userResourcePath() const
\fn QString ICore::userResourcePath()
\brief Returns the absolute path in the users directory that is used for
resources like project templates.
@@ -232,14 +225,14 @@
*/
/*!
\fn QMainWindow *ICore::mainWindow() const
\fn QWidget *ICore::mainWindow()
\brief Returns the main application window.
For use as dialog parent etc.
*/
/*!
\fn IContext *ICore::currentContextObject() const
\fn IContext *ICore::currentContextObject()
\brief Returns the context object of the current main context.
\sa ICore::updateAdditionalContexts()
@@ -294,7 +287,7 @@
*/
/*!
\fn ICore::ICore()
\fn ICore::ICore(Internal::MainWindow *mw)
\internal
*/

2
src/plugins/coreplugin/id.cpp
View File

@@ -134,7 +134,7 @@ static int theId(const QByteArray &ba)
}
/*!
\fn Core::Id(int uid)
\fn Core::Id::Id(int uid)
\brief Constructs an id given a UID.