From 0a8b59ab7b0e9df23471b7e85e3d7696ed04acb1 Mon Sep 17 00:00:00 2001
From: Javier Cicchelli <javier@rock-n-code.com>
Date: Mon, 7 Apr 2025 02:07:59 +0200
Subject: [PATCH] Documented the Doxy executable target and source code.

---
 App/Catalogs/Doxy.docc/DoxyApp.md         | 24 +++++++++++++++++++++++
 App/Catalogs/Doxy.docc/Extensions/Doxy.md |  7 +++++++
 App/Catalogs/DoxyApp.docc/DoxyApp.md      | 13 ------------
 3 files changed, 31 insertions(+), 13 deletions(-)
 create mode 100644 App/Catalogs/Doxy.docc/DoxyApp.md
 create mode 100644 App/Catalogs/Doxy.docc/Extensions/Doxy.md
 delete mode 100644 App/Catalogs/DoxyApp.docc/DoxyApp.md

diff --git a/App/Catalogs/Doxy.docc/DoxyApp.md b/App/Catalogs/Doxy.docc/DoxyApp.md
new file mode 100644
index 0000000..967f9de
--- /dev/null
+++ b/App/Catalogs/Doxy.docc/DoxyApp.md
@@ -0,0 +1,24 @@
+# ``DoxyApp``
+
+A command-line tool that starts the **Doxy** service in the local machine, based on the configuration provided by a 
+list of input parameters. 
+
+## Overview
+
+The service, in a nutshell, proxies the contents of each and every available `DocC` archive at a specific folder in the 
+local file system so they can be rendered by any web browser installed in the machine. Furthermore, it is also possible 
+to query the list of the available `DocC` archives that are found at the *archives* folder in the local file system.
+
+The implementation that builds the service in this executable is provided by the `DoxyLibrary` target, that could be 
+tested in total isolation. This is a standard pattern for [building command-line tools](https://www.swiftbysundell.com/articles/building-a-command-line-tool-using-the-swift-package-manager/) 
+with the [Swift programming language](https://www.swift.org).   
+
+## Topics
+
+### Executable
+
+- ``Doxy``
+
+### Input parameters
+
+- ``Doxy/Options``
diff --git a/App/Catalogs/Doxy.docc/Extensions/Doxy.md b/App/Catalogs/Doxy.docc/Extensions/Doxy.md
new file mode 100644
index 0000000..3810dca
--- /dev/null
+++ b/App/Catalogs/Doxy.docc/Extensions/Doxy.md
@@ -0,0 +1,7 @@
+# ``Doxy``
+
+## Topics
+
+### Input parameters
+
+- ``Doxy/Options``
diff --git a/App/Catalogs/DoxyApp.docc/DoxyApp.md b/App/Catalogs/DoxyApp.docc/DoxyApp.md
deleted file mode 100644
index 0ed52b2..0000000
--- a/App/Catalogs/DoxyApp.docc/DoxyApp.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# ``DoxyApp``
-
-<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
-
-## Overview
-
-<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
-
-## Topics
-
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
-
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->