Slight documentation

OpenDreamProject · Oct 20, 2023 · 3b5d647 · 3b5d647
1 parent c7c6515
commit 3b5d647
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/OpenDreamPackageTool/ClientPackaging.cs b/OpenDreamPackageTool/ClientPackaging.cs
@@ -3,6 +3,9 @@
 
 namespace OpenDreamPackageTool;
 
+/// <summary>
+/// Packages the client's resources & assemblies in a format ready to be downloaded by connecting clients
+/// </summary>
 public static class ClientPackaging {
     private static readonly string[] ClientIgnoredResources = {
         "Maps",

diff --git a/OpenDreamPackageTool/ServerPackaging.cs b/OpenDreamPackageTool/ServerPackaging.cs
@@ -4,6 +4,9 @@
 
 namespace OpenDreamPackageTool;
 
+/// <summary>
+/// Packages the server, and optionally the client alongside for hybrid ACZ
+/// </summary>
 public static class ServerPackaging {
     private static readonly PlatformReg[] Platforms = {
         new("win-x64", "Windows", true),

diff --git a/OpenDreamPackageTool/TgsPackaging.cs b/OpenDreamPackageTool/TgsPackaging.cs
@@ -4,6 +4,10 @@
 
 namespace OpenDreamPackageTool;
 
+/// <summary>
+/// Packages the OpenDream server, client (hybrid ACZ), and compiler in a format friendly for TGS
+/// See https://github.com/OpenDreamProject/OpenDream/issues/1495
+/// </summary>
 public static class TgsPackaging {
     public static void Package(Program.TgsOptions options) {
         if (Directory.Exists(options.OutputDir)) {