napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libcalamares] Document the pseudo-constructors for JobResult

Browse Source
This commit is contained in:
Adriaan de Groot 2019-10-01 16:05:03 +02:00
parent 9cbfd200a1
commit c8229733b0
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/libcalamares/Job.h
View File

@ -68,9 +68,16 @@ public:
/// @brief an "ok status" result /// @brief an "ok status" result
static JobResult ok(); static JobResult ok();
/// @brief an "error" result resulting from the execution of the job /** @brief an "error" result resulting from the execution of the job
*
* The error code is set to GenericError.
*/
static JobResult error( const QString& message, const QString& details = QString() ); static JobResult error( const QString& message, const QString& details = QString() );
/// @brief an "internal error" meaning the job itself has a problem (usually for python) /** @brief an "internal error" meaning the job itself has a problem (usually for python)
*
* Pass in a suitable error code; using 0 (which would normally mean "ok") instead
* gives you a GenericError code.
*/
static JobResult internalError( const QString&, const QString& details, int errorCode ); static JobResult internalError( const QString&, const QString& details, int errorCode );
protected: protected: