More doc headers

Villavu · Aug 16, 2023 · aabd51a · aabd51a
1 parent 3b2362e
commit aabd51a
Show file tree

Hide file tree

Showing 10 changed files with 1,154 additions and 52 deletions.
diff --git a/DocGen/doccomments.simba b/DocGen/doccomments.simba
@@ -29,7 +29,7 @@ begin
 end;
 
 begin
-  Contents := FileRead('Source/script/imports/simba/simba.import_timing.pas');
+  Contents := FileRead('Source/script/imports/simba/simba.import_misc.pas');
 
   for DocComment in Contents.BetweenAll('(*','*)') do
   begin

diff --git a/DocGen/docgen.simba b/DocGen/docgen.simba
@@ -11,29 +11,34 @@ var
   end;
 
 begin
-  SourceFiles += ['Source\script\imports\simba\simba.import_colormath.pas',    'Color Math'    ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_point.pas',        'TPoint'        ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_tpa.pas',          'TPointArray'   ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_atpa.pas',         'T2DPointArray' ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_box.pas',          'TBox'          ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_boxarray.pas',     'TBoxArray'     ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_quad.pas',         'TQuad'         ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_windowhandle.pas', 'TWindowHandle' ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_debugimage.pas',   'Debug Image'   ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_variant.pas',      'Variant'       ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_script.pas',       'Script'        ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_random.pas',       'Random'        ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_input.pas',        'Input'         ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_finder.pas',       'Finder'        ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_target.pas',       'Target'        ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_web.pas',          'Web'           ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_file.pas',         'File'          ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_encoding.pas',     'Encoding'      ];
-  SourceFiles += ['Source\script\imports\simba\simba.import_timing.pas',       'Timing'        ];
-
-  SourceFiles += ['Source\script\imports\simbaclasses\simba.import_class_json.pas',   'JSON'   ];
-  SourceFiles += ['Source\script\imports\simbaclasses\simba.import_class_bitmap.pas', 'Image'  ];
-  SourceFiles += ['Source\script\imports\simbaclasses\simba.import_class_dtm.pas',    'DTM'    ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_colormath.pas',     'Color Math'     ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_point.pas',         'TPoint'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_tpa.pas',           'TPointArray'    ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_atpa.pas',          'T2DPointArray'  ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_box.pas',           'TBox'           ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_boxarray.pas',      'TBoxArray'      ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_quad.pas',          'TQuad'          ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_windowhandle.pas',  'TWindowHandle'  ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_debugimage.pas',    'Debug Image'    ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_variant.pas',       'Variant'        ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_script.pas',        'Script'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_random.pas',        'Random'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_input.pas',         'Input'          ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_finder.pas',        'Finder'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_target.pas',        'Target'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_web.pas',           'Web'            ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_file.pas',          'File'           ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_encoding.pas',      'Encoding'       ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_timing.pas',        'Timing'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_string.pas',        'String'         ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_process.pas',       'Process'        ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_math.pas',          'Math'           ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_matchtemplate.pas', 'Match Template' ];
+  SourceFiles += ['Source\script\imports\simba\simba.import_misc.pas',          'Misc'           ];
+
+  SourceFiles += ['Source\script\imports\simbaclasses\simba.import_class_json.pas',   'JSON'     ];
+  SourceFiles += ['Source\script\imports\simbaclasses\simba.import_class_bitmap.pas', 'Image'    ];
+  SourceFiles += ['Source\script\imports\simbaclasses\simba.import_class_dtm.pas',    'DTM'      ];
 end;
 
 const

diff --git a/Source/forms/simba.functionlistform.pas b/Source/forms/simba.functionlistform.pas
@@ -125,27 +125,31 @@ function GetURL(const Section: String): String;
   Result := '';
 
   case Section of
-    'TPoint':        Result := 'https://villavu.github.io/Simba/TPoint.html';
-    'TPointArray':   Result := 'https://villavu.github.io/Simba/TPointArray.html';
-    'TBox':          Result := 'https://villavu.github.io/Simba/TBox.html';
-    'TBoxArray':     Result := 'https://villavu.github.io/Simba/TBoxArray.html';
-    'TQuad':         Result := 'https://villavu.github.io/Simba/TQuad.html';
-    'Random':        Result := 'https://villavu.github.io/Simba/Random.html';
-    'T2DPointArray': Result := 'https://villavu.github.io/Simba/T2DPointArray.html';
-    'Debug Image':   Result := 'https://villavu.github.io/Simba/Debug Image.html';
-    'Script':        Result := 'https://villavu.github.io/Simba/Script.html';
-    'Variant':       Result := 'https://villavu.github.io/Simba/Variant.html';
-    'TWindowHandle': Result := 'https://villavu.github.io/Simba/TWindowHandle.html';
-    'Image':         Result := 'https://villavu.github.io/Simba/Image.html';
-    'Finder':        Result := 'https://villavu.github.io/Simba/Finder.html';
-    'Input':         Result := 'https://villavu.github.io/Simba/Input.html';
-    'Target':        Result := 'https://villavu.github.io/Simba/Target.html';
-    'Web':           Result := 'https://villavu.github.io/Simba/Web.html';
-    'Encoding':      Result := 'https://villavu.github.io/Simba/Encoding.html';
-    'JSON':          Result := 'https://villavu.github.io/Simba/JSON.html';
-    'Color Math':    Result := 'https://villavu.github.io/Simba/Color Math.html';
-    'File':          Result := 'https://villavu.github.io/Simba/File.html';
-    'Timing':        Result := 'https://villavu.github.io/Simba/Timing.html';
+    'TPoint':         Result := 'https://villavu.github.io/Simba/TPoint.html';
+    'TPointArray':    Result := 'https://villavu.github.io/Simba/TPointArray.html';
+    'TBox':           Result := 'https://villavu.github.io/Simba/TBox.html';
+    'TBoxArray':      Result := 'https://villavu.github.io/Simba/TBoxArray.html';
+    'TQuad':          Result := 'https://villavu.github.io/Simba/TQuad.html';
+    'Random':         Result := 'https://villavu.github.io/Simba/Random.html';
+    'T2DPointArray':  Result := 'https://villavu.github.io/Simba/T2DPointArray.html';
+    'Debug Image':    Result := 'https://villavu.github.io/Simba/Debug Image.html';
+    'Script':         Result := 'https://villavu.github.io/Simba/Script.html';
+    'Variant':        Result := 'https://villavu.github.io/Simba/Variant.html';
+    'TWindowHandle':  Result := 'https://villavu.github.io/Simba/TWindowHandle.html';
+    'Image':          Result := 'https://villavu.github.io/Simba/Image.html';
+    'Finder':         Result := 'https://villavu.github.io/Simba/Finder.html';
+    'Input':          Result := 'https://villavu.github.io/Simba/Input.html';
+    'Target':         Result := 'https://villavu.github.io/Simba/Target.html';
+    'Web':            Result := 'https://villavu.github.io/Simba/Web.html';
+    'Encoding':       Result := 'https://villavu.github.io/Simba/Encoding.html';
+    'JSON':           Result := 'https://villavu.github.io/Simba/JSON.html';
+    'Color Math':     Result := 'https://villavu.github.io/Simba/Color Math.html';
+    'File':           Result := 'https://villavu.github.io/Simba/File.html';
+    'Timing':         Result := 'https://villavu.github.io/Simba/Timing.html';
+    'String':         Result := 'https://villavu.github.io/Simba/String.html';
+    'Process':        Result := 'https://villavu.github.io/Simba/Process.html';
+    'Match Template': Result := 'https://villavu.github.io/Simba/Match Template.html';
+    'Math':           Result := 'https://villavu.github.io/Simba/Math.html';
   end;
 end;
 

diff --git a/Source/script/imports/simba/simba.import_matchtemplate.pas b/Source/script/imports/simba/simba.import_matchtemplate.pas
@@ -21,46 +21,97 @@ implementation
   lptypes,
   simba.bitmap, simba.matchtemplate;
 
+(*
+Match Template
+==============
+Template matching
+*)
+
+(*
+TMatchTemplateCache.Create
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+> function TMatchTemplateCache.Create(Image, Template: TIntegerMatrix; Formula: ETMFormula): TMatchTemplateCache; static;
+*)
 procedure _LapeMatchTemplateCache_Create(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PMatchTemplateCacheBase(Result)^ := MatchTemplateCache(PIntegerMatrix(Params^[0])^, PIntegerMatrix(Params^[1])^, PTMFormula(Params^[2])^);
 end;
 
+(*
+TMatchTemplateCache.Create
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+> function TMatchTemplateCache.Create(Image, Template: TImage; Formula: ETMFormula): TMatchTemplateCache; static;
+*)
 procedure _LapeMatchTemplateCache_CreateEx(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PMatchTemplateCacheBase(Result)^ := MatchTemplateCache(PSimbaImage(Params^[0])^.ToMatrixBGR(), PSimbaImage(Params^[1])^.ToMatrixBGR(), PTMFormula(Params^[2])^);
 end;
 
+(*
+TMatchTemplateCache.FreeOnTerminate
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+> procedure TMatchTemplateCache.FreeOnTerminate(Enable: Boolean);
+*)
 procedure _LapeMatchTemplateCache_FreeOnTerminate(const Params: PParamArray); LAPE_WRAPPER_CALLING_CONV
 begin
   PMatchTemplateCacheBase(Params^[0])^.FreeOnTerminate := PBoolean(Params^[1])^;
 end;
 
+(*
+MatchTemplateMask
+~~~~~~~~~~~~~~~~~
+> function MatchTemplateMask(Cache: TMatchTemplateCache; Template: TIntegerMatrix; Formula: ETMFormula): TSingleMatrix;
+*)
 procedure _LapeMatchTemplateMaskCache(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PSingleMatrix(Result)^ := MatchTemplateMask(PMatchTemplateCacheBase(Params^[0])^, PIntegerMatrix(Params^[1])^, PTMFormula(Params^[2])^);
 end;
 
+(*
+MatchTemplateMask
+~~~~~~~~~~~~~~~~~
+> function MatchTemplateMask(Cache: TMatchTemplateCache; Template: TImage; Formula: ETMFormula): TSingleMatrix;
+*)
 procedure _LapeMatchTemplateMaskCacheEx(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PSingleMatrix(Result)^ := MatchTemplateMask(PMatchTemplateCacheBase(Params^[0])^, PSimbaImage(Params^[1])^.ToMatrixBGR(), PTMFormula(Params^[2])^);
 end;
 
+(*
+MatchTemplateMask
+~~~~~~~~~~~~~~~~~
+> function MatchTemplateMask(Image, Template: TIntegerMatrix; Formula: ETMFormula): TSingleMatrix;
+*)
 procedure _LapeMatchTemplateMask(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PSingleMatrix(Result)^ := MatchTemplateMask(PIntegerMatrix(Params^[0])^, PIntegerMatrix(Params^[1])^, PTMFormula(Params^[2])^);
 end;
 
+(*
+MatchTemplate
+~~~~~~~~~~~~~
+> function MatchTemplate(Image, Template: TIntegerMatrix; Formula: ETMFormula): TSingleMatrix;
+*)
 procedure _LapeMatchTemplate(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PSingleMatrix(Result)^ := MatchTemplate(PIntegerMatrix(Params^[0])^, PIntegerMatrix(Params^[1])^, PTMFormula(Params^[2])^);
 end;
 
+(*
+TImage.MatchTemplate
+~~~~~~~~~~~~~~~~~~~~
+> function TImage.MatchTemplate(Template: TImage; Formula: ETMFormula): TSingleMatrix;
+*)
 procedure _LapeMufasaBitmap_MatchTemplate(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PSingleMatrix(Result)^ := PSimbaImage(Params^[0])^.MatchTemplate(PSimbaImage(Params^[1])^, PTMFormula(Params^[2])^);
 end;
 
+(*
+TImage.MatchTemplateMask
+~~~~~~~~~~~~~~~~~~~~~~~~
+> function TImage.MatchTemplateMask(Template: TImage; Formula: ETMFormula): TSingleMatrix;
+*)
 procedure _LapeMufasaBitmap_MatchTemplateMask(const Params: PParamArray; const Result: Pointer); LAPE_WRAPPER_CALLING_CONV
 begin
   PSingleMatrix(Result)^ := PSimbaImage(Params^[0])^.MatchTemplateMask(PSimbaImage(Params^[1])^, PTMFormula(Params^[2])^);
@@ -95,4 +146,3 @@ procedure ImportMatchTemplate(Compiler: TSimbaScript_Compiler);
 end;
 
 end.
-