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

Doc: edit projectexplorer API docs

Browse Source 
Fix grammar, punctuation, and style issues. Use standard wording for
QDoc commands. Remove \brief commands from function descriptions.
Move some function descriptions directly above the functions, so
that the \fn command can be removed.

Change-Id: Iedf4f0041af24541a982241f99bd4906e86af916
Reviewed-by: Daniel Teske <daniel.teske@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-10 17:16:10 +02:00
parent c5c501669f
commit 6b99d2bb78
16 changed files with 213 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/plugins/projectexplorer/session.cpp
View File

@@ -70,8 +70,8 @@ using namespace ProjectExplorer::Internal;
\brief The SessionManager class manages sessions.
TODO the interface of this class is not really great.
The implementation suffers that all the functions from the
public interface just wrap around functions which do the actual work
The implementation suffers from that all the functions from the
public interface just wrap around functions which do the actual work.
This could be improved.
*/
@@ -615,7 +615,7 @@ void SessionManager::removeProjects(QList<Project *> remove)
}
/*!
\brief Let other plugins store persistent values within the session file.
Lets other plugins store persistent values within the session file.
*/
void SessionManager::setValue(const QString &name, const QVariant &value)
@@ -658,7 +658,7 @@ Utils::FileName SessionManager::sessionNameToFileName(const QString &session) co
}
/*!
\brief Just creates a new session (Does not actually create the file).
Creates \a session, but does not actually create the file.
*/
bool SessionManager::createSession(const QString &session)
@@ -692,7 +692,7 @@ bool SessionManager::confirmSessionDelete(const QString &session)
}
/*!
\brief Deletes session name from session list and file from disk.
Deletes \a session name from session list and the file from disk.
*/
bool SessionManager::deleteSession(const QString &session)
{
@@ -801,7 +801,7 @@ void SessionManager::restoreEditors(const Utils::PersistentSettingsReader &reade
}
/*!
\brief Loads a session, takes a session name (not filename).
Loads a session, takes a session name (not filename).
*/
void SessionManager::restoreProjects(const QStringList &fileList)
{