[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: extragear/sdk/kdevplatform/vcs
From: Milian Wolff <mail () milianw ! de>
Date: 2010-03-31 21:54:14
Message-ID: 20100331215414.EB0B0AC888 () svn ! kde ! org
[Download RAW message or body]
SVN commit 1109729 by mwolff:
Fix several typos etc. in API docs of VCS code.
Thanks to Nicolás Alvarez for the patch.
Review Board: 3055
CCMAIL: nicolas.alvarez@gmail.com
M +1 -1 dvcs/dvcsjob.cpp
M +20 -20 dvcs/dvcsjob.h
M +1 -1 dvcs/dvcsplugin.cpp
M +4 -4 dvcs/dvcsplugin.h
M +8 -8 vcsjob.h
M +10 -10 vcslocation.h
M +4 -4 vcsrevision.h
M +2 -2 widgets/vcsdiffpatchsources.h
--- trunk/extragear/sdk/kdevplatform/vcs/dvcs/dvcsjob.cpp #1109728:1109729
@@ -72,7 +72,7 @@
void DVcsJob::clear()
{
- //Do not use KProcess::clearEnvironment() (it sets the environment to kde_dummy.
+ //Do not use KProcess::clearEnvironment() (it sets the environment to \
kde_dummy). //Also DVCSjob can't set it, so it's ok.
d->command.clear();
d->output.clear();
--- trunk/extragear/sdk/kdevplatform/vcs/dvcs/dvcsjob.h #1109728:1109729
@@ -39,13 +39,13 @@
/**
* This class is capable of running our dvcs commands.
- * Most of all DVCSjobs are created in DVCS executors, but executed in \
DistributedVersionControlPlugin or + * Most of all DVcsJob are created in DVCS \
executors, but executed in DistributedVersionControlPlugin or
* any managers like BranchManager.
- * @note Connect to Kjob::result(KJob*) to be notified when the job finished.
+ * @note Connect to KJob::result(KJob*) to be notified when the job finished.
*
- * How to create DVCSjob:
+ * How to create DVcsJob:
* @code
- * DVCSjob* job = new DVCSjob(vcsplugin);
+ * DVcsJob* job = new DVcsJob(vcsplugin);
* if (job)
* {
* job->setDirectory(workDir);
@@ -61,7 +61,7 @@
* Usage example 1:
* @code
* VcsJob* j = add(DistributedVersionControlPlugin::d->m_ctxUrlList, \
IBasicVersionControl::Recursive);
- * DVCSjob* job = dynamic_cast<DVCSjob*>(j);
+ * DVcsJob* job = dynamic_cast<DVCSjob*>(j);
* if (job) {
* connect(job, SIGNAL(result(KJob*) ),
* this, SIGNAL(jobFinished(KJob*) ));
@@ -71,15 +71,15 @@
*
* Usage example 2:
* @code
- * DVCSjob *branchJob = d->branch(repo, baseBranch, newBranch);
- * DVCSjob* job = gitRevParse(dirPath.toLocalFile(), \
QStringList(QString("--is-inside-work-tree"))); + * DVcsJob* branchJob = \
d->branch(repo, baseBranch, newBranch); + * DVcsJob* job = \
gitRevParse(dirPath.toLocalFile(), \
QStringList(QString("--is-inside-work-tree")));
* if (job)
* {
* job->exec();
* if (job->status() == KDevelop::VcsJob::JobSucceeded)
* return true;
* else
- * //something, mabe even just
+ * //something, maybe even just
* return false
* }
* @endcode
@@ -106,13 +106,13 @@
/**
* Sets working directory.
- * @param directory Should contain only absolute path. Relative path or "" \
(working dir) are deprecated and will make job failed.
- * @note In DVCS plugins directory variable is used to get relative pathes.
+ * @param directory Should contain only absolute path. Relative paths or "" \
(working dir) are deprecated and will make the job fail. + * @note In DVCS \
plugins directory variable is used to get relative paths.
*/
void setDirectory(const QDir & directory);
/**
- * Sets standart Input file.
+ * Sets standard input file.
*/
void setStandardInputFile(const QString &fileName);
@@ -140,19 +140,19 @@
DVcsJob& operator<<(const QStringList& args);
/**
- * Call this mehod to start this job.
- * @note Default communiaction mode is KProcess::AllOutput.
+ * Call this method to start this job.
+ * @note Default communication mode is KProcess::AllOutput.
* @see Use setCommunicationMode() to override the default communication mode.
*/
virtual void start();
/**
- * In some cases it's needed to specify the communisation mode between the
+ * In some cases it's needed to specify the communication mode between the
* process and the job object. This is for instance done for the "git status"
- * command. If stdout and stderr are processed as separate streams their signals
- * do not always get emmited in correct order by KProcess. Which will lead to a
+ * command. If stdout and stderr are processed as separate streams, their \
signals + * do not always get emitted in correct order by KProcess, which will \
lead to a
* screwed up output.
- * @note Default communiaction mode is KProcess::SeparateChannels.
+ * @note Default communication mode is KProcess::SeparateChannels.
*/
void setCommunicationMode(KProcess::OutputChannelMode comm);
@@ -174,7 +174,7 @@
// Begin: KDevelop::VcsJob
/**
- * Sets executions reults.
+ * Sets executions results.
* In most cases this method is used by IDVCSexecutor
* @see fetchResults()
*/
@@ -190,8 +190,8 @@
/**
* Sets exit status (d->failed variable).
* Since only executors can parse the job to set result, they can connect \
parsers to readyForParsing(DVCSjob) using
- * Qt::DirectConnection to set the result. For example git-status can return \
exit status 1
- * if you don't set exit status in your parser then you will have JobFailes in \
status() result. + * Qt::DirectConnection to set the result. For example \
git-status can return exit status 1. + * If you don't set exit status in your \
parser then you will have JobFailed in status() result.
* @note First result is set in slotProcessExited() or slotProcessError().
*/
virtual void setExitStatus(const bool exitStatus);
--- trunk/extragear/sdk/kdevplatform/vcs/dvcs/dvcsplugin.cpp #1109728:1109729
@@ -264,7 +264,7 @@
kDebug() << "Project was closed, now it will be opened";
core()->projectController()->openProject(projectFile);
// maybe IProject::reloadModel?
-// emit jobFinished(_checkoutJob); //couses crash!
+// emit jobFinished(_checkoutJob); //causes crash!
}
KDevDVCSViewFactory * DistributedVersionControlPlugin::dvcsViewFactory() const
--- trunk/extragear/sdk/kdevplatform/vcs/dvcs/dvcsplugin.h #1109728:1109729
@@ -51,7 +51,7 @@
* KDevelop::IBasicVersionControl, KDevelop::IDistributedVersionControl and \
KDevelop::IPlugin (contextMenuExtension).
* DistributedVersionControlPlugin class uses IDVCSexecutor to get all jobs
* from real DVCS plugins like Git. It is based on KDevelop's CVS plugin (also looks \
like svn plugin is it's relative too).
- * @note Create only special items in contextMenuExtension, all standart menu items \
are created in vcscommon plugin! + * @note Create only special items in \
contextMenuExtension, all standard menu items are created in \
vcscommon plugin!
*/
class KDEVPLATFORMVCS_EXPORT DistributedVersionControlPlugin : public IPlugin, \
public IDistributedVersionControl {
@@ -76,7 +76,7 @@
// From KDevelop::IPlugin
/** Creates context menu
- * @note Create only special items here (like checkout), all standart menu items \
are created in vcscommon plugin! + * @note Create only special items here (like \
checkout), all standard menu items are created in vcscommon plugin!
*/
virtual ContextMenuExtension contextMenuExtension(Context*);
@@ -156,7 +156,7 @@
/** empty_cmd is used when something is not implemented, but has to return any \
job */
virtual DVcsJob* empty_cmd(KDevelop::OutputJob::OutputJobVerbosity verbosity = \
KDevelop::OutputJob::Verbose);
- /** Returs the list of all commits (in all branches).
+ /** Returns the list of all commits (in all branches).
* @see CommitView and CommitViewDelegate to see how this list is used.
*/
virtual QList<DVcsEvent> getAllCommits(const QString &repo) = 0;
@@ -184,7 +184,7 @@
/** Always returns directory path.
* @param path a path of a file or a directory.
- * @return if path argument if file then returns parent directory, otherwice \
path arg is returned. + * @return if path argument if file then returns parent \
directory, otherwise path arg is returned.
* @todo it will be nice to change prepareJob() so it can change its repository \
argument.
*/
static QString stripPathToDir(const QString &path);
--- trunk/extragear/sdk/kdevplatform/vcs/vcsjob.h #1109728:1109729
@@ -36,8 +36,8 @@
class IPlugin;
/**
- * This class provides an extension of KJob to get various Vcs
- * specific information about the job. This includes the type, the state
+ * This class provides an extension of KJob to get various VCS-specific
+ * information about the job. This includes the type, the state
* and the results provided by the job.
*
*/
@@ -48,7 +48,7 @@
VcsJob( QObject* parent = 0, OutputJobVerbosity verbosity = OutputJob::Verbose);
virtual ~VcsJob();
/**
- * To easily check which type of job this is
+ * To easily check which type of job this is.
*
* @TODO: Check how this can be extended via plugins, maybe use QFlag? (not
* QFlags!)
@@ -78,7 +78,7 @@
};
/**
- * Simple enum to define how the job finished
+ * Simple enum to define how the job finished.
*/
enum JobStatus
{
@@ -99,7 +99,7 @@
virtual QVariant fetchResults() = 0;
/**
- * Find out in which state the job is, it can be running, cancelled
+ * Find out in which state the job is. It can be running, canceled,
* failed or finished
*
* @return the status of the job
@@ -108,7 +108,7 @@
virtual JobStatus status() const = 0;
/**
- * Used to find out about the type of job
+ * Used to find out about the type of job.
*
* @return the type of job
*/
@@ -117,14 +117,14 @@
/**
* Used to get at the version control plugin. The plugin
* can be used to get one of the interfaces to execute
- * more vcs actions, depending on this jobs results
+ * more vcs actions, depending on this job's results
* (like getting a diff for an entry in a log)
*/
virtual KDevelop::IPlugin* vcsPlugin() const = 0;
protected:
/**
- * This can be used to set the type of the vcs job in subclasses
+ * This can be used to set the type of the vcs job in subclasses.
*/
void setType( JobType );
--- trunk/extragear/sdk/kdevplatform/vcs/vcslocation.h #1109728:1109729
@@ -32,10 +32,10 @@
namespace KDevelop
{
/**
- * Denotes a local or repository location for a Vcs system
+ * Denotes a local or repository location for a Vcs system.
*
- * For the RepositoryLocation type most of the information
- * are vcs specific
+ * For the RepositoryLocation type, most of the information
+ * is vcs-specific.
*/
class KDEVPLATFORMVCS_EXPORT VcsLocation
{
@@ -59,27 +59,27 @@
KUrl localUrl() const;
/**
- * Returns a string for the repository, usually this identifies the server
+ * Returns a string for the repository, usually this identifies the server.
* @returns a vcs-implementation-specific string identifying the server
*/
QString repositoryServer() const;
/**
- * Returns the module or module path inside the server
+ * Returns the module or module path inside the server.
* @returns a vcs-implementation-specific string identifying the module
*/
QString repositoryModule() const;
/**
- * identifies the tag which this location belongs to
+ * Identifies the tag which this location belongs to.
* @returns a vcs-implementation-specific string identifying the tag
*/
QString repositoryTag() const;
/**
- * identifies the branch to which this location belongs to
+ * Identifies the branch to which this location belongs to.
* @returns a vcs-implementation-specific string identifying the branch
*/
QString repositoryBranch() const;
/**
- * This can define a path relative to the module, this is used
+ * This can define a path relative to the module. This is used
* when identifying a subdirectory or file inside a repository location
* @returns a path relative to module
*/
@@ -117,8 +117,8 @@
void setRepositoryPath( const QString& );
/**
- * Allows to add vcs-specific data to this location
- * automatically sets the type to RepositoryLocation
+ * Allows to add vcs-specific data to this location.
+ * Automatically sets the type to RepositoryLocation
* @param data the vcs-specific data
*/
void setUserData( const QVariant& );
--- trunk/extragear/sdk/kdevplatform/vcs/vcsrevision.h #1109728:1109729
@@ -31,11 +31,11 @@
{
/**
- * Encapsulates a vcs revision number, date or range of revisions
+ * Encapsulates a vcs revision number, date or range of revisions.
*
* The type of the QVariant value depends on the type of the revision,
* the following table lists the standard types and the according datatype
- * in the qvariant:
+ * in the QVariant:
*
* <table>
* <tr><th>Revision type</th><th>QVariant type</th></tr>
@@ -109,8 +109,8 @@
RevisionType revisionType() const;
/**
- * return the value of this revision
- * The actualy content depends on the type of this revision, the possible
+ * Return the value of this revision.
+ * The actual content depends on the type of this revision, the possible
* combinations are:
*
* FileNumber/GlobalNumber -> qlonglong
--- trunk/extragear/sdk/kdevplatform/vcs/widgets/vcsdiffpatchsources.h \
#1109728:1109729 @@ -84,8 +84,8 @@
KDevelop::IBasicVersionControl* m_vcs;
};
-///Sends the diff to the patch-review plugin
-///Returns whether the diff was shown successfully
+///Sends the diff to the patch-review plugin.
+///Returns whether the diff was shown successfully.
bool showVcsDiff(KDevelop::IPatchSource* vcsDiff);
#endif // VCSDIFFPATCHSOURCES_H
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic