jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document SonarStep.h

Browse Source 
Summary: It may not be immediately obvious how this works, so adding comments.

Reviewed By: passy

Differential Revision: D9333321

fbshipit-source-id: 79740b3d2a9589b3ba48c47b0068afdaf26f35a3
This commit is contained in:
John Knox
2018-08-15 06:03:11 -07:00
committed by Facebook Github Bot
parent 38391ca29e
commit e76a6ef529
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
xplat/Sonar/SonarStep.h
View File

@@ -14,8 +14,14 @@ class SonarState;
class SonarStep { class SonarStep {
public: public:
/* Mark this step as completed successfully
* failing to call complete() will be registered as a failure
* when the destructor is executed. */
void complete(); void complete();
// Mark the step as failed, and provide a message.
void fail(std::string message); void fail(std::string message);
SonarStep(std::string name, SonarState* state); SonarStep(std::string name, SonarState* state);
~SonarStep(); ~SonarStep();