Bläddra i källkod

CTest: Fix ctest_sleep documentation (#11554)

Document behavior consistently with the implementation.
Brad King 15 år sedan
förälder
incheckning
7145ca67fc
1 ändrade filer med 4 tillägg och 5 borttagningar
  1. 4 5
      Source/CTest/cmCTestSleepCommand.h

+ 4 - 5
Source/CTest/cmCTestSleepCommand.h

@@ -63,11 +63,10 @@ public:
   virtual const char* GetFullDocumentation()
     {
     return
-      "  ctest_sleep( seconds )\n"
-      "  ctest_sleep( time1 duration time2 )\n"
-      "With one argument it will sleep for a given number of seconds. "
-      "With three arguments it will wait for time2 - time1 - duration "
-      "seconds.";
+      "  ctest_sleep(<seconds>)\n"
+      "Sleep for given number of seconds.\n"
+      "  ctest_sleep(<time1> <duration> <time2>)\n"
+      "Sleep for t=(time1 + duration - time2) seconds if t > 0.";
     }
 
   cmTypeMacro(cmCTestSleepCommand, cmCTestCommand);