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

Documentation: Add ProjectExplorer plugin..

Browse Source 
Reformat existing documentation to qdoc.
This commit is contained in:
Friedemann Kleint
2011-04-14 12:58:14 +02:00
parent dc3c156cac
commit fcdc8177b1
56 changed files with 979 additions and 439 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
src/plugins/projectexplorer/processparameters.cpp
View File

@@ -38,6 +38,18 @@
#include <QtCore/QFileInfo>
#include <QtCore/QDir>
/*!
\class ProjectExplorer::ProcessParameters
\brief ProcessParameters aggregates all parameters needed to start a process.
It offers a set of functions which expand macros and environment variables
inside the raw parameters to obtain final values for starting a process
or for display purposes.
\sa ProjectExplorer::AbstractProcessStep
*/
using namespace ProjectExplorer;
ProcessParameters::ProcessParameters() :
@@ -46,24 +58,55 @@ ProcessParameters::ProcessParameters() :
{
}
/*!
\brief Sets the executable to run.
*/
void ProcessParameters::setCommand(const QString &cmd)
{
m_command = cmd;
m_effectiveCommand.clear();
}
/*!
\brief Sets the command line arguments used by the process
*/
void ProcessParameters::setArguments(const QString &arguments)
{
m_arguments = arguments;
m_effectiveArguments.clear();
}
/*!
\brief Sets the workingDirectory for the process for a buildConfiguration
should be called from init()
*/
void ProcessParameters::setWorkingDirectory(const QString &workingDirectory)
{
m_workingDirectory = workingDirectory;
m_effectiveWorkingDirectory.clear();
}
/*!
\fn void ProjectExplorer::ProcessParameters::setEnvironment(const Utils::Environment &env)
\brief Set the Environment for running the command
Should be called from init()
*/
/*!
\fn void ProjectExplorer::ProcessParameters::setMacroExpander(Utils::AbstractMacroExpander *mx)
\brief Set the macro expander to use on the command, arguments and working dir.
Note that the caller retains ownership of the object.
*/
/*!
\brief Get the fully expanded working directory.
*/
QString ProcessParameters::effectiveWorkingDirectory() const
{
if (m_effectiveWorkingDirectory.isEmpty()) {
@@ -75,6 +118,10 @@ QString ProcessParameters::effectiveWorkingDirectory() const
return m_effectiveWorkingDirectory;
}
/*!
\brief Get the fully expanded command name to run
*/
QString ProcessParameters::effectiveCommand() const
{
if (m_effectiveCommand.isEmpty()) {
@@ -90,6 +137,10 @@ QString ProcessParameters::effectiveCommand() const
return m_effectiveCommand;
}
/*!
\brief True if effectiveCommand() would return only a fallback.
*/
bool ProcessParameters::commandMissing() const
{
effectiveCommand();