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

Updated the content for the overview of the DoxyApp documentation page and also, added the reference to the Doxy installation tutorial.

Browse Source
This commit is contained in:
Javier Cicchelli 2025-04-10 00:26:06 +02:00
parent f610fa9a2b
commit 2d64d832c0
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
App/Catalogs/Doxy.docc/DoxyApp.md
View File

@ -5,9 +5,10 @@ list of input parameters.
## Overview ## Overview
The service, in a nutshell, proxies the contents of each and every available `DocC` archive at a specific folder in the The ``Doxy`` service, in a nutshell, proxies the contents of each and every available `DocC` archive at a specific folder
local file system so they can be rendered by any web browser installed in the machine. Furthermore, it is also possible 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. 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 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/) 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 ## Topics
### Executable ### Essentials
- <doc:DoxyInstallation>
### Service
- ``Doxy`` - ``Doxy``

4
App/Catalogs/Doxy.docc/Extensions/Doxy.md
View File

@ -2,6 +2,10 @@
## Topics ## Topics
### Essentials
- <doc:DoxyInstallation>
### Input parameters ### Input parameters
- ``Doxy/Options`` - ``Doxy/Options``