Minor tweak to Delphi Timer utility

AngusJohnson · Oct 2, 2022 · ff73799 · ff73799
1 parent 3f4bc09
commit ff73799
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/Delphi/BenchMark/DelphiBenchmark.dpr b/Delphi/BenchMark/DelphiBenchmark.dpr
@@ -50,7 +50,7 @@ begin
       clip[0] := MakeRandomPath(maxWidth, maxHeight, edgeCount);
 
       begin
-        DoTimer(timerResult);
+        InitTimer(timerResult);
         solution := Intersect(subj, clip, frNonZero);
       end;
       timeTotal := timeTotal + timerResult;

diff --git a/Delphi/Utils/Timer.pas b/Delphi/Utils/Timer.pas
@@ -6,6 +6,22 @@ interface
   Windows,
   SysUtils;
 
+(*******************************************************************************
+*  Example:                                                                    *
+*                                                                              *
+*    var                                                                       *
+*      time: double;                                                           *
+*    begin                                                                     *
+*      ...                                                                     *
+*      begin                                                                   *
+*        InitTimer(time);                                                      *
+*        DoSomeLengthyOp();                                                    *
+*      end;                                                                    *
+*      Caption := Format('DoSomeLengthyOp took %1.3n secs', [time]);              *
+*      ....                                                                    *
+*    end;                                                                      *
+*******************************************************************************)
+
 {$IFDEF FPC}
   {$MODE DELPHI}
 {$ENDIF}
@@ -16,7 +32,7 @@ interface
   ['{A50173E8-6497-4F83-B4A8-9C0D5D709834}']
   end;
 
-function DoTimer(out timeResult: double): ITimer;
+function InitTimer(out timeResult: double): ITimer;
 
 implementation
 
@@ -81,7 +97,7 @@ class function TTimer.Release(Inst: PTimerData): Integer; stdcall;
   Dispose(Inst);
 end;
 
-function DoTimer(out timeResult: double): ITimer;
+function InitTimer(out timeResult: double): ITimer;
 var
   timer: PTimerData;
 begin