Deploying to javadoc from @ e5e7410 🚀

oscar-schwarz · Jun 2, 2024 · d84b781 · d84b781
1 parent 2849b08
commit d84b781
Show file tree

Hide file tree

Showing 25 changed files with 156 additions and 55 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>All Classes and Interfaces (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -71,9 +71,13 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 <div class="block">The <code>Key</code> interface provides methods for generating and retrieving keys.</div>
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="rsa_encryption/KeyGenerator.html" title="class in rsa_encryption">KeyGenerator</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">The <code>KeyGenerator</code> class is responsible for generating RSA key pairs.</div>
+</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="rsa_encryption/KeyPair.html" title="class in rsa_encryption">KeyPair</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">The <code>KeyPair</code> class represents a pair of RSA keys, consisting of a public key and a private key.</div>
+</div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="rsa_encryption/Main.html" title="class in rsa_encryption">Main</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="rsa_encryption/PrivateKey.html" title="class in rsa_encryption">PrivateKey</a></div>

diff --git a/javadoc/allpackages-index.html b/javadoc/allpackages-index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>All Packages (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/help-doc.html b/javadoc/help-doc.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>API Help (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/index-all.html b/javadoc/index-all.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>Index (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -79,11 +79,17 @@ <h2 class="title" id="I:G">G</h2>
 <div class="block">Generates the RSA public key.</div>
 </dd>
 <dt><a href="rsa_encryption/KeyGenerator.html#generateKeys()" class="member-name-link">generateKeys()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyGenerator.html" title="class in rsa_encryption">KeyGenerator</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Generates the RSA public and private keys.</div>
+</dd>
 <dt><a href="rsa_encryption/KeyPair.html#generatePrivateKey()" class="member-name-link">generatePrivateKey()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyPair.html" title="class in rsa_encryption">KeyPair</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Generates the private key.</div>
+</dd>
 <dt><a href="rsa_encryption/KeyPair.html#generatePublicKey()" class="member-name-link">generatePublicKey()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyPair.html" title="class in rsa_encryption">KeyPair</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Generates the public key.</div>
+</dd>
 <dt><a href="rsa_encryption/ChatParticipant.html#getChatPartner()" class="member-name-link">getChatPartner()</a> - Method in class rsa_encryption.<a href="rsa_encryption/ChatParticipant.html" title="class in rsa_encryption">ChatParticipant</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="rsa_encryption/CryptoFileString.html#getContent()" class="member-name-link">getContent()</a> - Method in class rsa_encryption.<a href="rsa_encryption/CryptoFileString.html" title="class in rsa_encryption">CryptoFileString</a></dt>
@@ -119,15 +125,21 @@ <h2 class="title" id="I:G">G</h2>
 <div class="block">Retrieves the generated cryptographic key.</div>
 </dd>
 <dt><a href="rsa_encryption/KeyGenerator.html#getKeyPair()" class="member-name-link">getKeyPair()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyGenerator.html" title="class in rsa_encryption">KeyGenerator</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Retrieves the generated key pair.</div>
+</dd>
 <dt><a href="rsa_encryption/ChatParticipant.html#getName()" class="member-name-link">getName()</a> - Method in class rsa_encryption.<a href="rsa_encryption/ChatParticipant.html" title="class in rsa_encryption">ChatParticipant</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="rsa_encryption/KeyPair.html#getPrivateKey()" class="member-name-link">getPrivateKey()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyPair.html" title="class in rsa_encryption">KeyPair</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Retrieves the private key.</div>
+</dd>
 <dt><a href="rsa_encryption/ChatParticipant.html#getPublicKey()" class="member-name-link">getPublicKey()</a> - Method in class rsa_encryption.<a href="rsa_encryption/ChatParticipant.html" title="class in rsa_encryption">ChatParticipant</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="rsa_encryption/KeyPair.html#getPublicKey()" class="member-name-link">getPublicKey()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyPair.html" title="class in rsa_encryption">KeyPair</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Retrieves the public key.</div>
+</dd>
 </dl>
 <h2 class="title" id="I:K">K</h2>
 <dl class="index">
@@ -136,15 +148,25 @@ <h2 class="title" id="I:K">K</h2>
 <div class="block">The <code>Key</code> interface provides methods for generating and retrieving keys.</div>
 </dd>
 <dt><a href="rsa_encryption/KeyGenerator.html" class="type-name-link" title="class in rsa_encryption">KeyGenerator</a> - Class in <a href="rsa_encryption/package-summary.html">rsa_encryption</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">The <code>KeyGenerator</code> class is responsible for generating RSA key pairs.</div>
+</dd>
 <dt><a href="rsa_encryption/KeyGenerator.html#%3Cinit%3E(int,int)" class="member-name-link">KeyGenerator(int, int)</a> - Constructor for class rsa_encryption.<a href="rsa_encryption/KeyGenerator.html" title="class in rsa_encryption">KeyGenerator</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Constructs a <code>KeyGenerator</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+</dd>
 <dt><a href="rsa_encryption/KeyGenerator.html#%3Cinit%3E(java.math.BigInteger,java.math.BigInteger)" class="member-name-link">KeyGenerator(BigInteger, BigInteger)</a> - Constructor for class rsa_encryption.<a href="rsa_encryption/KeyGenerator.html" title="class in rsa_encryption">KeyGenerator</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Constructs a <code>KeyGenerator</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+</dd>
 <dt><a href="rsa_encryption/KeyPair.html" class="type-name-link" title="class in rsa_encryption">KeyPair</a> - Class in <a href="rsa_encryption/package-summary.html">rsa_encryption</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">The <code>KeyPair</code> class represents a pair of RSA keys, consisting of a public key and a private key.</div>
+</dd>
 <dt><a href="rsa_encryption/KeyPair.html#%3Cinit%3E(java.math.BigInteger,java.math.BigInteger)" class="member-name-link">KeyPair(BigInteger, BigInteger)</a> - Constructor for class rsa_encryption.<a href="rsa_encryption/KeyPair.html" title="class in rsa_encryption">KeyPair</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Constructs a <code>KeyPair</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+</dd>
 </dl>
 <h2 class="title" id="I:M">M</h2>
 <dl class="index">
@@ -203,7 +225,9 @@ <h2 class="title" id="I:T">T</h2>
 <div class="block">Alias for <code>getContent</code> for comfort.</div>
 </dd>
 <dt><a href="rsa_encryption/KeyGenerator.html#toString()" class="member-name-link">toString()</a> - Method in class rsa_encryption.<a href="rsa_encryption/KeyGenerator.html" title="class in rsa_encryption">KeyGenerator</a></dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Returns a string representation of the key pair.</div>
+</dd>
 <dt><a href="rsa_encryption/CryptoFileString.html#transform(rsa_encryption.Key)" class="member-name-link">transform(Key)</a> - Method in class rsa_encryption.<a href="rsa_encryption/CryptoFileString.html" title="class in rsa_encryption">CryptoFileString</a></dt>
 <dd>
 <div class="block">Transform the content using a certain key with the RSA algorithm.</div>

diff --git a/javadoc/index.html b/javadoc/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>rsa_encryption 1.0-SNAPSHOT API</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/overview-tree.html b/javadoc/overview-tree.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>Class Hierarchy (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/rsa_encryption/ChatParticipant.html b/javadoc/rsa_encryption/ChatParticipant.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>ChatParticipant (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/rsa_encryption/CryptoFileString.html b/javadoc/rsa_encryption/CryptoFileString.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>CryptoFileString (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/rsa_encryption/Key.html b/javadoc/rsa_encryption/Key.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>Key (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/javadoc/rsa_encryption/KeyGenerator.html b/javadoc/rsa_encryption/KeyGenerator.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Sun Jun 02 21:37:33 UTC 2024 -->
+<!-- Generated by javadoc (17) on Sun Jun 02 21:41:00 UTC 2024 -->
 <title>KeyGenerator (rsa_encryption 1.0-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -78,6 +78,7 @@ <h1 title="Class KeyGenerator" class="title">Class KeyGenerator</h1>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">KeyGenerator</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
+<div class="block">The <code>KeyGenerator</code> class is responsible for generating RSA key pairs.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -91,10 +92,14 @@ <h2>Constructor Summary</h2>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,int)" class="member-name-link">KeyGenerator</a><wbr>(int&nbsp;p,
  int&nbsp;q)</code></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Constructs a <code>KeyGenerator</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+</div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.math.BigInteger,java.math.BigInteger)" class="member-name-link">KeyGenerator</a><wbr>(<a href="https://docs.oracle.com/javase/7/docs/api/java/math/BigInteger.html" title="class or interface in java.math" class="external-link">BigInteger</a>&nbsp;p,
  <a href="https://docs.oracle.com/javase/7/docs/api/java/math/BigInteger.html" title="class or interface in java.math" class="external-link">BigInteger</a>&nbsp;q)</code></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Constructs a <code>KeyGenerator</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+</div>
 </div>
 </section>
 </li>
@@ -111,13 +116,19 @@ <h2>Method Summary</h2>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateKeys()" class="member-name-link">generateKeys</a>()</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Generates the RSA public and private keys.</div>
+</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KeyPair.html" title="class in rsa_encryption">KeyPair</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKeyPair()" class="member-name-link">getKeyPair</a>()</code></div>
-<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Retrieves the generated key pair.</div>
+</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Returns a string representation of the key pair.</div>
+</div>
 </div>
 </div>
 </div>
@@ -140,13 +151,25 @@ <h2>Constructor Details</h2>
 <h3>KeyGenerator</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">KeyGenerator</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/7/docs/api/java/math/BigInteger.html" title="class or interface in java.math" class="external-link">BigInteger</a>&nbsp;p,
  <a href="https://docs.oracle.com/javase/7/docs/api/java/math/BigInteger.html" title="class or interface in java.math" class="external-link">BigInteger</a>&nbsp;q)</span></div>
+<div class="block">Constructs a <code>KeyGenerator</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>p</code> - the first prime number.</dd>
+<dd><code>q</code> - the second prime number.</dd>
+</dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(int,int)">
 <h3>KeyGenerator</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">KeyGenerator</span><wbr><span class="parameters">(int&nbsp;p,
  int&nbsp;q)</span></div>
+<div class="block">Constructs a <code>KeyGenerator</code> with specified prime numbers <code>p</code> and <code>q</code>.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>p</code> - the first prime number.</dd>
+<dd><code>q</code> - the second prime number.</dd>
+</dl>
 </section>
 </li>
 </ul>
@@ -161,21 +184,30 @@ <h2>Method Details</h2>
 <section class="detail" id="generateKeys()">
 <h3>generateKeys</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">generateKeys</span>()</div>
+<div class="block">Generates the RSA public and private keys.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getKeyPair()">
 <h3>getKeyPair</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="KeyPair.html" title="class in rsa_encryption">KeyPair</a></span>&nbsp;<span class="element-name">getKeyPair</span>()</div>
+<div class="block">Retrieves the generated key pair.</div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>the key pair as a <code>KeyPair</code>.</dd>
+</dl>
 </section>
 </li>
 <li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
+<div class="block">Returns a string representation of the key pair.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
+<dt>Returns:</dt>
+<dd>a string representation of the public and private keys.</dd>
 </dl>
 </section>
 </li>