Updated the content for the overview of the DoxyApp documentation page and also, added the reference to the Doxy installation tutorial.
This commit is contained in:
parent
f610fa9a2b
commit
2d64d832c0
@ -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
|
||||
|
||||
- <doc:DoxyInstallation>
|
||||
|
||||
### Service
|
||||
|
||||
- ``Doxy``
|
||||
|
||||
|
@ -2,6 +2,10 @@
|
||||
|
||||
## Topics
|
||||
|
||||
### Essentials
|
||||
|
||||
- <doc:DoxyInstallation>
|
||||
|
||||
### Input parameters
|
||||
|
||||
- ``Doxy/Options``
|
||||
|
Loading…
x
Reference in New Issue
Block a user