From dcc0b509c2c3532812695d5fef924b23228fe0b6 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Thu, 10 Apr 2025 00:27:53 +0200 Subject: [PATCH] Updated the contents for the DoxyLibrary documentation in the library target. --- Library/Catalogs/DoxyLibrary.docc/DoxyLibrary.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/Library/Catalogs/DoxyLibrary.docc/DoxyLibrary.md b/Library/Catalogs/DoxyLibrary.docc/DoxyLibrary.md index e057e31..916d333 100644 --- a/Library/Catalogs/DoxyLibrary.docc/DoxyLibrary.md +++ b/Library/Catalogs/DoxyLibrary.docc/DoxyLibrary.md @@ -4,13 +4,17 @@ A library that provides the **Doxy** service builder to the `DoxyApp` executable ## Overview -The library, in a nutshell, provides a public builder that creates a fully configured [Hummingbird](https://hummingbird.codes) -application that is ready-to-use by the `DoxyApp` executable target. +The library, in a nutshell, provides a public ``AppBuilder`` builder that creates a fully functional [Hummingbird](https://hummingbird.codes) +application that is ready-to-use by the `DoxyApp` executable target. Furthermore, this application can be configured +with the ``AppArguments`` parameters the executable receives as inputs. -In addition, all the business logic required by the `DocC` archives controller that provides the necessary resources, -and the `DocC` middleware that proxies the contents of documentation archives in the local machine is being implemented -in this target, including all its relevant protocols and types. Plus, the unit tests for every type implemented in this -target are being written in the `DoxyTests` target. +In addition, all the business logic required by the ``ArchiveController`` controller that provides the list of available +`DocC` archives at an specific location in the local file system, and the ``DocCMiddleware`` middleware that proxies the +contents of requested documentation archives in the local machine have been implemented in this target, including all its +relevant protocols and types. + +Plus, the test cases for every type found in this target have been written in the `DoxyTests` unit tests target using the + new [Swift Testing](https://developer.apple.com/xcode/swift-testing/) testing framework. ## Topics