From 2d64d832c0062905c81361cddea0ed65f858cfd5 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 10 Apr 2025 00:26:06 +0200 Subject: [PATCH] Updated the content for the overview of the DoxyApp documentation page and also, added the reference to the Doxy installation tutorial. --- App/Catalogs/Doxy.docc/DoxyApp.md | 13 +++++++++---- App/Catalogs/Doxy.docc/Extensions/Doxy.md | 4 ++++ 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/App/Catalogs/Doxy.docc/DoxyApp.md b/App/Catalogs/Doxy.docc/DoxyApp.md index 967f9de..2d394e5 100644 --- a/App/Catalogs/Doxy.docc/DoxyApp.md +++ b/App/Catalogs/Doxy.docc/DoxyApp.md @@ -5,9 +5,10 @@ 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 ``Doxy`` 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. Finally, +the service could be configured by injecting ``Doxy/Options`` parameters as input parameters in the command-line interface. 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/) @@ -15,7 +16,11 @@ with the [Swift programming language](https://www.swift.org). ## Topics -### Executable +### Essentials + +- + +### Service - ``Doxy`` diff --git a/App/Catalogs/Doxy.docc/Extensions/Doxy.md b/App/Catalogs/Doxy.docc/Extensions/Doxy.md index 3810dca..1a0938a 100644 --- a/App/Catalogs/Doxy.docc/Extensions/Doxy.md +++ b/App/Catalogs/Doxy.docc/Extensions/Doxy.md @@ -2,6 +2,10 @@ ## Topics +### Essentials + +- + ### Input parameters - ``Doxy/Options``