Provide security settings model documentation

kwin · kwin · commit 35ebb3d6e46d · 2025-01-28T11:56:03.000+01:00
Improve documentation This closes #88
diff --git a/pom.xml b/pom.xml
@@ -13,6 +13,7 @@
   <version>4.0.4-SNAPSHOT</version>
 
   <name>Plexus Security Dispatcher Component</name>
+  <description>This library provides encryption/decryption functionality with pluggable ciphers and password providers</description>
 
   <scm>
     <connection>scm:git:git@github.com:codehaus-plexus/plexus-sec-dispatcher.git</connection>
@@ -98,6 +99,13 @@
               <goal>stax-writer</goal>
             </goals>
           </execution>
+          <execution>
+            <id>generate-xdoc</id>
+            <goals>
+              <goal>xdoc</goal>
+            </goals>
+            <phase>pre-site</phase>
+          </execution>
         </executions>
       </plugin>
       <plugin>
diff --git a/src/main/mdo/settings-security.mdo b/src/main/mdo/settings-security.mdo
@@ -20,7 +20,7 @@
 
   <id>settings-security</id>
   <name>SecurityConfiguration</name>
-  <description>SecurityConfiguration</description>
+  <description>The security configuration contains all settings related to the encryption/decryption functionality</description>
 
   <defaults>
     <default>
@@ -32,13 +32,14 @@
   <classes>
     <class rootElement="true">
       <name>SettingsSecurity</name>
+      <description>Root element containing all security settings.</description>
       <version>1.0.0+</version>
       <fields>
         <field>
           <name>master</name>
           <version>1.0.0/2.1.0</version>
           <type>String</type>
-          <description>encrypted master password</description>
+          <description>Encrypted master password.</description>
         </field>
         <field>
           <name>relocation</name>
@@ -52,7 +53,7 @@
           <version>3.0.0+</version>
           <type>String</type>
           <required>true</required>
-          <description>The version of the model</description>
+          <description>The version of the model, use '4.0' for the most recent one.</description>
         </field>
         <field>
           <name>masterSource</name>
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -0,0 +1,8 @@
+<site xmlns="http://maven.apache.org/SITE/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
+    <body>
+        <menu name="Overview">
+            <item name="Settings" href="settings-security.html"/>
+        </menu>
+    </body>
+</site>
