From eec8990481b00faf51be10d6e6a8e3f67131e081 Mon Sep 17 00:00:00 2001
From: Graham <gpe@openrs2.dev>
Date: Sun, 18 Aug 2019 14:20:28 +0100
Subject: [PATCH] Add description to all modules

---
 asm/pom.xml              | 2 ++
 bundler/pom.xml          | 3 +++
 decompiler/pom.xml       | 3 +++
 deob-annotations/pom.xml | 2 ++
 deob-ast/pom.xml         | 2 ++
 deob/pom.xml             | 4 ++++
 game/pom.xml             | 2 ++
 gl-dri-natives/pom.xml   | 3 +++
 gl-natives/pom.xml       | 4 ++++
 misc-natives/pom.xml     | 4 ++++
 util/pom.xml             | 1 +
 11 files changed, 30 insertions(+)

diff --git a/asm/pom.xml b/asm/pom.xml
index 4d6f0ea7..cc78471f 100644
--- a/asm/pom.xml
+++ b/asm/pom.xml
@@ -12,6 +12,8 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 ASM Utilities</name>
+  <description>Common utility code used for manipulating Java
+    bytecode with the ASM library.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/bundler/pom.xml b/bundler/pom.xml
index 92dedcce..473a8ef3 100644
--- a/bundler/pom.xml
+++ b/bundler/pom.xml
@@ -12,6 +12,9 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 Bundler</name>
+  <description>A tool for patching the RuneScape client to allow it to connect
+    to an OpenRS2 server and improve compatibility with modern
+    JVMs.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/decompiler/pom.xml b/decompiler/pom.xml
index 21f2aaed..1002941a 100644
--- a/decompiler/pom.xml
+++ b/decompiler/pom.xml
@@ -12,6 +12,9 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 Decompiler</name>
+  <description>A thin wrapper around OpenRS2's fork of Fernflower that sets the
+    standard options required to decompile the RuneScape client and its
+    dependencies.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/deob-annotations/pom.xml b/deob-annotations/pom.xml
index 13c8e944..3d4524d9 100644
--- a/deob-annotations/pom.xml
+++ b/deob-annotations/pom.xml
@@ -12,6 +12,8 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 Deobfuscator Annotations</name>
+  <description>Annotations inserted by the deobfuscator to track the original
+    names and descriptors of classes, methods and fields.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/deob-ast/pom.xml b/deob-ast/pom.xml
index 83dd3f64..a595e327 100644
--- a/deob-ast/pom.xml
+++ b/deob-ast/pom.xml
@@ -12,6 +12,8 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 AST Deobfuscator</name>
+  <description>A tool for performing AST-level deobfuscation of the RuneScape
+    client. It may be run after decompiling the client.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/deob/pom.xml b/deob/pom.xml
index 069ea3f3..a98098fd 100644
--- a/deob/pom.xml
+++ b/deob/pom.xml
@@ -12,6 +12,10 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 Bytecode Deobfuscator</name>
+  <description>A tool for performing bytecode-level deobfuscation of the
+    RuneScape client. It must be run before decompiling the client - some of the
+    transformations it performs are required for the decompiler to produce valid
+    output.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/game/pom.xml b/game/pom.xml
index 90e0f964..b0cbaa4a 100644
--- a/game/pom.xml
+++ b/game/pom.xml
@@ -12,6 +12,8 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 Game Server</name>
+  <description>Reimplementation of the RuneScape game server
+    software.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/gl-dri-natives/pom.xml b/gl-dri-natives/pom.xml
index 52b6f8a8..e7940c7b 100644
--- a/gl-dri-natives/pom.xml
+++ b/gl-dri-natives/pom.xml
@@ -12,6 +12,9 @@
   <packaging>nar</packaging>
 
   <name>OpenRS2 GL DRI Natives</name>
+  <description>Reimplementation of the jaggl_dri native library, which
+    implements the DRI hack to support the open-source Mesa drivers on UNIX
+    systems.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/gl-natives/pom.xml b/gl-natives/pom.xml
index b59b4f03..db9151c0 100644
--- a/gl-natives/pom.xml
+++ b/gl-natives/pom.xml
@@ -12,6 +12,10 @@
   <packaging>nar</packaging>
 
   <name>OpenRS2 GL Natives</name>
+  <description>Reimplementation of the jaggl native library, which implements
+    OpenGL bindings for Windows (WGL), macOS (CGL) and UNIX (GLX) systems. This
+    implementation supports modern versions of Java on macOS, as it is backed
+    by a CALayer instead of an NSView.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/misc-natives/pom.xml b/misc-natives/pom.xml
index a8a6b8a3..c802cbae 100644
--- a/misc-natives/pom.xml
+++ b/misc-natives/pom.xml
@@ -12,6 +12,10 @@
   <packaging>nar</packaging>
 
   <name>OpenRS2 Misc Natives</name>
+  <description>Reimplementation of the jagmisc native library, which implements
+    a high-precision timer for Windows systems. It is queried from a thread
+    pinned to a single processor core to work around hardware
+    bugs.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>
diff --git a/util/pom.xml b/util/pom.xml
index 1c3be011..ca80cf3c 100644
--- a/util/pom.xml
+++ b/util/pom.xml
@@ -12,6 +12,7 @@
   <packaging>jar</packaging>
 
   <name>OpenRS2 Utilities</name>
+  <description>Common utility code used by all modules.</description>
 
   <properties>
     <openrs2.root>${project.parent.basedir}</openrs2.root>