NATT-SPI documentation update

0xMartin · Aug 11, 2024 · 41aacb4 · 41aacb4
1 parent 8b30d06
commit 41aacb4
Show file tree

Hide file tree

Showing 44 changed files with 296 additions and 129 deletions.
diff --git a/natt-spi/doc/allclasses-index.html b/natt-spi/doc/allclasses-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Aug 11 23:46:27 CEST 2024 -->
+<!-- Generated by javadoc (17) on Mon Aug 12 00:01:59 CEST 2024 -->
 <title>All Classes and Interfaces</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-11">
+<meta name="dc.created" content="2024-08-12">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -61,24 +61,28 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="table-header col-first">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="utb/fai/natt/spi/IMessageBuffer.html" title="interface in utb.fai.natt.spi">IMessageBuffer</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Interface for the message buffer.</div>
+</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="utb/fai/natt/spi/IMessageListener.html" title="interface in utb.fai.natt.spi">IMessageListener</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
 <div class="block">Interface for a message listener.</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="utb/fai/natt/spi/INATTContext.html" title="interface in utb.fai.natt.spi">INATTContext</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">
-<div class="block">Interface for the test context.</div>
+<div class="block">Interface for the NATT context.</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="utb/fai/natt/spi/INATTMessage.html" title="interface in utb.fai.natt.spi">INATTMessage</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
+<div class="block">Interface for the NATT message.</div>
+</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="utb/fai/natt/spi/INATTMessage.SearchType.html" title="enum class in utb.fai.natt.spi">INATTMessage.SearchType</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab3">
 <div class="block">Enumeration for the type of search.</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="utb/fai/natt/spi/INATTPlugin.html" title="interface in utb.fai.natt.spi">INATTPlugin</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
-<div class="block">Interface for NATT plugins.</div>
+<div class="block">Main interface for NATT plugins.</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="utb/fai/natt/spi/exception/InternalErrorException.html" title="class in utb.fai.natt.spi.exception">InternalErrorException</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
@@ -93,7 +97,9 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="block">Annotation for simple and clear definition of keyword parameters.</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/NATTAssert.html" title="class in utb.fai.natt.spi">NATTAssert</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Class for asserting data matching between variables and expected values.</div>
+</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/NATTKeyword.html" title="class in utb.fai.natt.spi">NATTKeyword</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
 <div class="block">Abstract class for a keyword.</div>
@@ -111,12 +117,16 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="block">Type of parameter value.</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/NATTLogger.html" title="class in utb.fai.natt.spi">NATTLogger</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">NATTLogger is a utility class for logging messages to Sytem.out and file.</div>
+</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/NATTLogger.LogFileWriter.html" title="class in utb.fai.natt.spi">NATTLogger.LogFileWriter</a></div>
-<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Singleton class for writing log messages to a file.</div>
+</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/NATTModule.html" title="class in utb.fai.natt.spi">NATTModule</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
-<div class="block">Abstract class for basic module access</div>
+<div class="block">Abstract class for NATT module.</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/NATTModule.MessageFilter.html" title="class in utb.fai.natt.spi">NATTModule.MessageFilter</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -127,7 +137,9 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="utb/fai/natt/spi/exception/NonUniqueTestNamesException.html" title="class in utb.fai.natt.spi.exception">NonUniqueTestNamesException</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="utb/fai/natt/spi/StatusCode.html" title="class in utb.fai.natt.spi">StatusCode</a></div>
-<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
+<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
+<div class="block">Enumeration of NATT status codes.</div>
+</div>
 </div>
 </div>
 </div>

diff --git a/natt-spi/doc/allpackages-index.html b/natt-spi/doc/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Aug 11 23:46:27 CEST 2024 -->
+<!-- Generated by javadoc (17) on Mon Aug 12 00:01:59 CEST 2024 -->
 <title>All Packages</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-11">
+<meta name="dc.created" content="2024-08-12">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/natt-spi/doc/constant-values.html b/natt-spi/doc/constant-values.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Aug 11 23:46:27 CEST 2024 -->
+<!-- Generated by javadoc (17) on Mon Aug 12 00:01:59 CEST 2024 -->
 <title>Constant Field Values</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-11">
+<meta name="dc.created" content="2024-08-12">
 <meta name="description" content="summary of constants">
 <meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

diff --git a/natt-spi/doc/help-doc.html b/natt-spi/doc/help-doc.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Aug 11 23:46:27 CEST 2024 -->
+<!-- Generated by javadoc (17) on Mon Aug 12 00:01:59 CEST 2024 -->
 <title>API Help</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="dc.created" content="2024-08-11">
+<meta name="dc.created" content="2024-08-12">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">