Documented the Doxy library target and source code.

This commit is contained in:
Javier Cicchelli 2025-04-07 03:02:07 +02:00
parent 0a8b59ab7b
commit c5b24737c4

View File

@ -1,13 +1,43 @@
# ``DoxyLibrary``
<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
A library that provides the **Doxy** service builder to the `DoxyApp` executable target.
## Overview
<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
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.
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.
## Topics
### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
### Builders 🔓
- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->
- ``AppBuilder``
- ``AppArguments``
### Controllers 🔐
- ``ArchiveController``
### Middlewares 🔐
- ``DocCMiddleware``
- ``PathProvider``
- ``AssetPrefix``
- ``IndexPrefix``
- ``StaticFile``
- ``Pathable``
### Models 🔐
- ``ArchiveList``
### Services 🔐
- ``FileService``
- ``FileServicing``
- ``FileServiceError``