Skip to content

Commit 75ec781

Browse files
rkapl123rkapl123
committed
fully automatized devdoc creation
amended code overview with missing files
1 parent ab484e4 commit 75ec781

File tree

6 files changed

+42
-49
lines changed

6 files changed

+42
-49
lines changed

‎docs/devdoc/4294969219.htm

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ <h2>Syntax</h2>
1212
Type:
1313
String</div><div>error message</div></dd><dt>rowNum</dt><dd><div>
1414
Type:
15-
Int64</div><div>error cell row</div></dd><dt>colNum</dt><dd><div>
15+
Int64</div><div>error cell row (optional, if not given then everything is selected)</div></dd><dt>colNum</dt><dd><div>
1616
Type:
17-
Int32</div><div>error cell column</div></dd></dl></div><div class="return"><h3>Returns</h3><div class="item">Boolean</div><div class="returns"></div></div></div><div class="footer">
17+
Int32</div><div>error cell column (optional, if not given then whole row is selected)</div></dd></dl></div><div class="return"><h3>Returns</h3><div class="item">Boolean</div><div class="returns"></div></div></div><div class="footer">
1818
Produced by the <a href="https://livedocumenter.barryjones.me.uk/">Live Documenter</a>.
1919
</div></body></html>

‎docs/devdoc/index.htm

+12-20
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ <h3 id="db-functions-and-their-config-files">DB Functions and their config files
3939
</ul>
4040
<h3 id="db-modifiers">DB Modifiers</h3>
4141
<ul>
42-
<li>DBModif.vb - DBModif Class: Abstraction of a DB Modification Object and descendant concrete classes DBMapper, DBAction or DBSeqnce; also contains global helper functions for DBModifiers and an abstract helper class CustomCommandBuilder for building Insert/Update/Delete Statements for DBMapper having concrete implementations in CustomSqlCommandBuilder, CustomOleDbCommandBuilder and CustomOdbcCommandBuilder.</li>
42+
<li>DBModif.vb - DBModif Class: Abstraction of a DB Modification Object and descendant concrete classes DBMapper, DBAction or DBSeqnce; contains an abstract helper class CustomCommandBuilder for building Insert/Update/Delete Statements for DBMapper having concrete implementations in CustomSqlCommandBuilder, CustomOleDbCommandBuilder and CustomOdbcCommandBuilder.</li>
43+
<li>DBModifHelper.vb - global helper functions for DBModifiers</li>
4344
<li>DBModifCreate.vb - Dialog for creating DB Modifier configurations</li>
4445
<li>EditDBModifDef.vb - Dialog used to display and edit the CustomXMLPart utilized for storing the DBModif definitions, reused to also show DBAddin settings</li>
4546
</ul>
@@ -49,30 +50,21 @@ <h3 id="dbsheet-definition-creation-and-assignment">DBSheet definition creation
4950
<li>DBSheetCreateForm.vb - Form for defining/creating DBSheet definitions</li>
5051
<li>DBConnHelper.vb - connection helper class (Connection configuration data) used for DBSheetCreateForm.vb and AdHocSQL.vb</li>
5152
</ul>
52-
<h3 id="addin-global-code">Addin global code</h3>
53+
<h3 id="addin-gui-modules">Addin GUI modules</h3>
5354
<ul>
54-
<li>Globals.vb - Global variables and functions for DB Addin</li>
55-
<li>MenuHandler.vb - handles all Menu related aspects (context menu for building/refreshing, &quot;DBAddin&quot;/&quot;Load Config&quot; tree menu for retrieving stored configuration files, etc.)</li>
55+
<li>MenuHandler.vb - the ExcelRibbon derived MenuHandler class takes care of all Ribbon Menu related aspects, including display of the &quot;Load Config&quot; tree menu for retrieving stored configuration files and the cell context menu for building/refreshing. The contained MenuHandlerGlobals module contains the global variables theRibbon and theAdHocSQLDlg and the public procedures refreshData and jumpButton</li>
5656
<li>AboutBox.vb - About box: used to provide information about version/buildtime and links for local help and project homepage</li>
57-
<li>AddInEvents.vb - AddIn Connection class, also handling Events from Excel (Open, Close, Activate)</li>
5857
<li>AdHocSQL.vb - Issuing adhoc SQL Commands from a dialog box</li>
58+
<li>DBDocumentation.vb - simple popup dialog for displaying DB Documentation</li>
59+
</ul>
60+
<h3 id="addin-global-code">Addin global code</h3>
61+
<ul>
62+
<li>AddInEvents.vb - AddIn Connection class, also handling Events from Excel (Open, Close, Activate)</li>
63+
<li>Globals.vb - Global variables and functions for DB Addin</li>
64+
<li>Logging.vb - logging and message related functions</li>
5965
</ul>
6066

61-
<h2>Namespaces</h2>
62-
<table>
63-
<thead>
64-
<tr>
65-
<th>Name</th>
66-
<th>Description</th>
67-
</tr>
68-
</thead>
69-
<tr>
70-
<td>
71-
<a href="4294967296-DBaddin.htm">DBaddin</a>
72-
</td>
73-
<td/>
74-
</tr>
75-
</table>
67+
<h2><a href="https://rkapl123.github.io/DBAddin">Back to DBaddin</a></h2>
7668
</div>
7769
<div class="footer">
7870
Produced by the <a href="https://livedocumenter.barryjones.me.uk/">Live Documenter</a>.

‎docs/finalizedoc.cmd

-3
This file was deleted.

‎docs/index.htm.bak

+12-20
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@
3939
</ul>
4040
<h3 id="db-modifiers">DB Modifiers</h3>
4141
<ul>
42-
<li>DBModif.vb - DBModif Class: Abstraction of a DB Modification Object and descendant concrete classes DBMapper, DBAction or DBSeqnce; also contains global helper functions for DBModifiers and an abstract helper class CustomCommandBuilder for building Insert/Update/Delete Statements for DBMapper having concrete implementations in CustomSqlCommandBuilder, CustomOleDbCommandBuilder and CustomOdbcCommandBuilder.</li>
42+
<li>DBModif.vb - DBModif Class: Abstraction of a DB Modification Object and descendant concrete classes DBMapper, DBAction or DBSeqnce; contains an abstract helper class CustomCommandBuilder for building Insert/Update/Delete Statements for DBMapper having concrete implementations in CustomSqlCommandBuilder, CustomOleDbCommandBuilder and CustomOdbcCommandBuilder.</li>
43+
<li>DBModifHelper.vb - global helper functions for DBModifiers</li>
4344
<li>DBModifCreate.vb - Dialog for creating DB Modifier configurations</li>
4445
<li>EditDBModifDef.vb - Dialog used to display and edit the CustomXMLPart utilized for storing the DBModif definitions, reused to also show DBAddin settings</li>
4546
</ul>
@@ -49,30 +50,21 @@
4950
<li>DBSheetCreateForm.vb - Form for defining/creating DBSheet definitions</li>
5051
<li>DBConnHelper.vb - connection helper class (Connection configuration data) used for DBSheetCreateForm.vb and AdHocSQL.vb</li>
5152
</ul>
52-
<h3 id="addin-global-code">Addin global code</h3>
53+
<h3 id="addin-gui-modules">Addin GUI modules</h3>
5354
<ul>
54-
<li>Globals.vb - Global variables and functions for DB Addin</li>
55-
<li>MenuHandler.vb - handles all Menu related aspects (context menu for building/refreshing, &quot;DBAddin&quot;/&quot;Load Config&quot; tree menu for retrieving stored configuration files, etc.)</li>
55+
<li>MenuHandler.vb - the ExcelRibbon derived MenuHandler class takes care of all Ribbon Menu related aspects, including display of the &quot;Load Config&quot; tree menu for retrieving stored configuration files and the cell context menu for building/refreshing. The contained MenuHandlerGlobals module contains the global variables theRibbon and theAdHocSQLDlg and the public procedures refreshData and jumpButton</li>
5656
<li>AboutBox.vb - About box: used to provide information about version/buildtime and links for local help and project homepage</li>
57-
<li>AddInEvents.vb - AddIn Connection class, also handling Events from Excel (Open, Close, Activate)</li>
5857
<li>AdHocSQL.vb - Issuing adhoc SQL Commands from a dialog box</li>
58+
<li>DBDocumentation.vb - simple popup dialog for displaying DB Documentation</li>
59+
</ul>
60+
<h3 id="addin-global-code">Addin global code</h3>
61+
<ul>
62+
<li>AddInEvents.vb - AddIn Connection class, also handling Events from Excel (Open, Close, Activate)</li>
63+
<li>Globals.vb - Global variables and functions for DB Addin</li>
64+
<li>Logging.vb - logging and message related functions</li>
5965
</ul>
6066

61-
<h2>Namespaces</h2>
62-
<table>
63-
<thead>
64-
<tr>
65-
<th>Name</th>
66-
<th>Description</th>
67-
</tr>
68-
</thead>
69-
<tr>
70-
<td>
71-
<a href="4294967296-DBaddin.htm">DBaddin</a>
72-
</td>
73-
<td/>
74-
</tr>
75-
</table>
67+
<h2><a href="https://rkapl123.github.io/DBAddin">Back to DBaddin</a></h2>
7668
</div>
7769
<div class="footer">
7870
Produced by the <a href="https://livedocumenter.barryjones.me.uk/">Live Documenter</a>.

‎docs/run_devdoc.cmd

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
rmdir /S /Q devdoc
2+
cd C:\dev\livedocumenter\exporter\net471\
3+
exporter.exe C:\dev\DBAddin.NET\docs\DBaddin.ldproj -to C:\dev\DBAddin.NET\docs\ -filters "public|protected|internalprotected|private"
4+
SETLOCAL EnableDelayedExpansion
5+
set fname=""
6+
cd C:\dev\DBAddin.NET\docs
7+
for /d %%a in (*) do (
8+
set fname=%%~na
9+
set res=!fname:~0,9!
10+
if /i "!res!"=="LD Export" set "FolderPath=%%a"
11+
)
12+
echo !FolderPath!
13+
rename "!FolderPath!" devdoc
14+
del devdoc\8589934*
15+
copy /Y index.htm.bak devdoc\index.htm
16+
pause

‎docs/rundoc.cmd

-4
This file was deleted.

0 commit comments

Comments
 (0)