Release v1.0.0: Added JavaDoc documentation and configured Maven deployment

Author: joha1na

pom.xml

@@ -42,7 +42,37 @@
     </dependency>
   </dependencies>
 
+  <distributionManagement>
+    <repository>
+      <id>github</id>
+      <name>GitHub Packages</name>
+      <url>https://maven.pkg.github.com/joha1na/my-prose-app</url>
+    </repository>
+  </distributionManagement>
+
   <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.6.3</version>
+        <executions>
+          <execution>
+            <id>attach-javadocs</id>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <show>private</show>
+          <nohelp>true</nohelp>
+          <charset>UTF-8</charset>
+          <encoding>UTF-8</encoding>
+          <docencoding>UTF-8</docencoding>
+        </configuration>
+      </plugin>
+    </plugins>
     <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
       <plugins>
         <plugin>
@@ -93,12 +123,4 @@
       </plugin>
     </plugins>
   </reporting>
-
-  <distributionManagement>
-    <repository>
-      <id>github</id>
-      <name>GitHub Packages</name>
-      <url>https://maven.pkg.github.com/joha1na/my-prose-app</url>
-    </repository>
-  </distributionManagement>
 </project>

src/main/java/de/htw_berlin/fb4/examples/App.java

@@ -4,15 +4,33 @@
 import de.htw_berlin.fb4.ossd.prose.Sentence;
 import de.htw_berlin.fb4.ossd.prose.Prose;
 
-public class App
-{
+/**
+ * Main application class for demonstrating the Prose and Sentence implementations.
+ * This class shows the usage of the ProseBuilder class and the conversion
+ * between Prose and Sentence objects.
+ * 
+ * @author Jana Maire
+ * @version 1.0.0
+ * @see de.htw_berlin.fb4.ossd.prose.Sentence
+ * @see de.htw_berlin.fb4.ossd.prose.Prose
+ * @see de.htw_berlin.fb4.ossd.prose.ProseBuilder
+ */
+public class App {
+    /**
+     * The main method of the application.
+     * Creates various Sentence and Prose objects, converts between them,
+     * and uses the ProseBuilder to compose the texts.
+     * 
+     * @param args Command line arguments (not used)
+     */
     public static void main( String[] args )
     {
         Sentence s1 = new SimpleSentence();
         Sentence s2 = new SimpleSentence();
         Prose prose = new SimpleProse();
 
-        // Konvertierung von Prose zu Sentence
+        // Conversion from Prose to Sentence: This step demonstrates how a Prose object can be transformed into a Sentence object 
+        // to enable further processing / registration in the ProseBuilder for text composition.
         Sentence s3 = SimpleSentence.toSentence(prose);
 
         ProseBuilder pb = new ProseBuilder();

src/main/java/de/htw_berlin/fb4/examples/SimpleProse.java

@@ -3,11 +3,24 @@
 import de.htw_berlin.fb4.ossd.prose.Prose;
 
 /**
- * Eine einfache Implementierung der Prose-Schnittstelle.
+ * A simple implementation of the Prose interface.
+ * This class provides an immutable prose text that can be used as a basic
+ * text container in the prose composition system. The text content is
+ * initialized upon creation and remains constant throughout the object's lifecycle.
+ * 
+ * @author Jana Maire
+ * @version 1.0.0
+ * @see de.htw_berlin.fb4.ossd.prose.Prose
  */
 public class SimpleProse implements Prose {
     private String text = "Dies ist ein einfacher Prose-Text, der die Prose-Schnittstelle implementiert.";
 
+    /**
+     * Returns the text content of this prose object.
+     * This method implements the {@link Prose#get()} method from the Prose interface.
+     * 
+     * @return The prose text as a String, which is immutable for this implementation
+     */
     @Override
     public String get() {
         return text;

src/main/java/de/htw_berlin/fb4/examples/SimpleSentence.java

@@ -4,17 +4,43 @@
 import de.htw_berlin.fb4.ossd.prose.Prose;
 
 /**
- * Eine einfache Implementierung der Sentence-Schnittstelle.
+ * A simple implementation of the Sentence interface.
+ * This class represents a single sentence and provides functionality
+ * to convert Prose objects into Sentence objects. It maintains its text content
+ * and can be used as a building block in larger text compositions through
+ * the ProseBuilder system.
+ * 
+ * @author Jana Maire
+ * @version 1.0.0
+ * @see de.htw_berlin.fb4.ossd.prose.Sentence
+ * @see de.htw_berlin.fb4.ossd.prose.Prose
  */
 public class SimpleSentence implements Sentence {
     private String text = "Hallo, das ist ein einfacher Satz.";
 
+    /**
+     * Converts a Prose object into a Sentence object.
+     * This static factory method creates a new SimpleSentence instance
+     * containing the text from the provided Prose object.
+     * 
+     * @param prose The Prose object to convert
+     * @return A new Sentence object containing the text from the Prose object
+     * @throws NullPointerException if the provided Prose object is null
+     * @see de.htw_berlin.fb4.ossd.prose.Prose#get()
+     */
     public static Sentence toSentence(Prose prose) {
         SimpleSentence sentence = new SimpleSentence();
         sentence.text = prose.get();
         return sentence;
     }
 
+    /**
+     * Returns the text content of this sentence.
+     * This method implements the {@link Sentence#get()} method from the Sentence interface.
+     * The text content represents a single sentence that can be used in text composition.
+     * 
+     * @return The sentence text as a String
+     */
     @Override
     public String get() {
         return text;