rock-n-code/doxy
1
0
Fork 0
Code Pull Requests Releases 1 Activity

Updated the contents for the DoxyLibrary documentation in the library target.

Browse Source
This commit is contained in:
Javier Cicchelli 2025-04-10 00:27:53 +02:00
parent 382dabeda8
commit dcc0b509c2
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Library/Catalogs/DoxyLibrary.docc/DoxyLibrary.md
View File

@ -4,13 +4,17 @@ A library that provides the **Doxy** service builder to the `DoxyApp` executable
## Overview ## Overview
The library, in a nutshell, provides a public builder that creates a fully configured [Hummingbird](https://hummingbird.codes) 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. 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, In addition, all the business logic required by the ``ArchiveController`` controller that provides the list of available
and the `DocC` middleware that proxies the contents of documentation archives in the local machine is being implemented `DocC` archives at an specific location in the local file system, and the ``DocCMiddleware`` middleware that proxies the
in this target, including all its relevant protocols and types. Plus, the unit tests for every type implemented in this contents of requested documentation archives in the local machine have been implemented in this target, including all its
target are being written in the `DoxyTests` target. 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 ## Topics