mp library document API added

Author: freshhope

.gitignore

@@ -31,3 +31,5 @@
 *.out
 *.app
 *.db
+*.stat
+*.opendb

Delphi/MPLibrary_Delphi.dpr

@@ -13,14 +13,16 @@ uses
   uMPHeader_Delphi in 'src\uMPHeader_Delphi.pas',
   uMPFunctionsImpl in 'src\uMPFunctionsImpl.pas',
   uTSMasterInternal_Delphi in 'src\uTSMasterInternal_Delphi.pas',
-  uIncLibTSMaster in 'src\uIncLibTSMaster.pas';
+  uIncLibTSMaster in 'src\uIncLibTSMaster.pas',
+  uMPDocuments in 'src\uMPDocuments.pas';
 
 {$R *.res}
 
 exports
   initialize_miniprogram, // start run of mini program
   finalize_miniprogram,   // stop run of mini program
-  retrieve_mp_abilities;  // get mp abilities before run
+  retrieve_mp_abilities,  // get mp abilities before run
+  write_api_document;     // write api document
 
 begin
 end.

Delphi/MPLibrary_Delphi.dproj

@@ -160,6 +160,9 @@ interface
   TLIBTSMasterLogger = procedure(const AStr: PAnsiChar; const ALevel: Integer); stdcall;
   TFirmwareUpdateCallback = procedure(const AOpaque: TObject; const AStatus: UInt32; const APercentage100: Single); stdcall;
   TOnIoIPData = procedure(const APointer: Pointer; const ASize: Integer); stdcall;
+  TLIBWriteAPIDocumentFunc = procedure (const AObj: Pointer; const AName: pansichar; const AGroup: pansichar; const ADesc: pansichar; const AExample: pansichar; const AParaCount: integer); stdcall;
+  TLIBWriteAPIParaFunc = procedure (const AObj: Pointer; const AIdx: integer; const AAPIName: pansichar; const AParaName: pansichar; const AIsConst: boolean; const AParaType: pansichar; const ADesc: pansichar); stdcall;
+  TLIBWriteAPIDocument = procedure (const AObj: Pointer; const AWriteDoc: TLIBWriteAPIDocumentFunc; const AWritePara: TLIBWriteAPIParaFunc); stdcall;
 
 {$Z4}
   // for c type

Delphi/src/uIncLibTSMaster.pas

@@ -0,0 +1,29 @@
+unit uMPDocuments;
+
+interface
+
+uses
+  windows,
+  sysutils,
+  classes,
+  uinclibtsmaster;
+
+procedure write_api_document(const AObj: Pointer; const AWriteDoc: TLIBWriteAPIDocumentFunc; const AWritePara: TLIBWriteAPIParaFunc); stdcall;
+
+implementation
+
+procedure write_api_document(const AObj: Pointer; const AWriteDoc: TLIBWriteAPIDocumentFunc; const AWritePara: TLIBWriteAPIParaFunc); stdcall;
+const
+  GROUP_NAME = 'MPLibrary_Delphi';
+begin
+  // API - perform_add
+  AWriteDoc(AObj, 'perform_add', GROUP_NAME, 'Simple add function API exported by Delphi', 's32 i = MPLibrary_Delphi.perform_add(1, 2);', 2);
+  AWritePara(AObj, 0, 'perform_add', 'A1', true, 's32', 'Parameter 1');
+  AWritePara(AObj, 1, 'perform_add', 'A2', true, 's32', 'Parameter 2');
+  // API - perform_dec
+  AWriteDoc(AObj, 'perform_dec', GROUP_NAME, 'Simple dec function API exported by Delphi', 's32 i = MPLibrary_Delphi.perform_dec(1);', 1);
+  AWritePara(AObj, 0, 'perform_dec', 'A1', true, 's32', 'Parameter 1');
+
+end;
+
+end.

Delphi/src/uMPDocuments.pas

@@ -3,3 +3,4 @@ EXPORTS
 initialize_miniprogram
 finalize_miniprogram
 retrieve_mp_abilities
+write_api_document

VC++/MPExport.def

@@ -162,6 +162,7 @@
     <ClInclude Include="pch.h" />
     <ClInclude Include="Test.h" />
     <ClInclude Include="TSMaster.h" />
+    <ClInclude Include="TSMasterBaseInclude.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="Database.cpp" />
@@ -174,6 +175,7 @@
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">Create</PrecompiledHeader>
       <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|x64'">Create</PrecompiledHeader>
     </ClCompile>
+    <ClCompile Include="TSMasterBaseSource.cpp" />
   </ItemGroup>
   <ItemGroup>
     <None Include="MPExport.def" />

VC++/MPLibrary-VC.vcxproj

@@ -33,6 +33,9 @@
     <ClInclude Include="TSMaster.h">
       <Filter>头文件</Filter>
     </ClInclude>
+    <ClInclude Include="TSMasterBaseInclude.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="dllmain.cpp">
@@ -50,6 +53,9 @@
     <ClCompile Include="MPLibCodeExtern.cpp">
       <Filter>源文件</Filter>
     </ClCompile>
+    <ClCompile Include="TSMasterBaseSource.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <None Include="MPExport.def">

VC++/MPLibrary-VC.vcxproj.filters

@@ -423,6 +423,8 @@ typedef void (__stdcall *TProcedureSetCANFD)(const void* AObj, const PCANFD AVal
 typedef TCANFD (__stdcall *TTCANFDFunction)(const void* AObj);
 typedef void (__stdcall *TProcedureSetLIN)(const void* AObj, const PLIN AValue);
 typedef TLIN (__stdcall *TTLINFunction)(const void* AObj);
+typedef void(__stdcall* TWriteAPIDocumentFunc)(const void* AOpaque, const char* AName, const char* AGroup, const char* ADesc, const char* AExample, const s32 AParaCount);
+typedef void(__stdcall* TWriteAPIParaFunc)(const void* AOpaque, const s32 AIdx, const char* AAPIName, const char* AParaName, const bool AIsConst, const char* AParaType, const char* ADesc);
 
 // TSMaster variable =============================================
 typedef struct {

VC++/TSMaster.h

@@ -0,0 +1,6 @@
+#ifndef __TSMASTER_BASE_INCLUDE
+#define __TSMASTER_BASE_INCLUDE
+
+#include "TSMaster.h"
+
+#endif

VC++/TSMasterBaseInclude.h

@@ -0,0 +1,9 @@
+#include "TSMasterBaseInclude.h"
+
+DLLEXPORT void __stdcall write_api_document(const void* AOpaque, const TWriteAPIDocumentFunc AAPIFunc, const TWriteAPIParaFunc AParaFunc){
+  AAPIFunc(AOpaque, "func1", "MPLibraryVC", "description of this example API", "s32 i = MPLibraryVC.func1(1, 2);", 2);
+  AParaFunc(AOpaque, 0, "func1", "A1", true, "s32", "Parameter 1");
+  AParaFunc(AOpaque, 1, "func1", "A2", true, "s32", "Parameter 2");
+
+}
+