@@ -72,13 +72,13 @@ $ Documentation/
7272
7373#### swift-doc coverage
7474
75- The ` coverage ` subcommand
75+ The ` coverage ` subcommand
7676generates documentation coverage statistics for Swift files.
7777
7878``` terminal
7979$ git clone https://github.com/SwiftDocOrg/SwiftSemantics.git
8080
81- $ swift run swift-doc coverage SwiftSemantics/Sources/ --output "dcov.json"
81+ $ swift run swift-doc coverage SwiftSemantics/Sources/ --output "dcov.json"
8282$ cat dcov.json | jq ".data.totals"
8383{
8484 "count": 207,
@@ -145,14 +145,20 @@ are formatted for publication to your project's [GitHub Wiki][github wiki],
145145which you can do with
146146[ github-wiki-publish-action] [ github-wiki-publish-action ] .
147147Alternatively,
148- you could publish ` swift-doc ` -generated documentation to GitHub Pages,
148+ you could specify HTML format publish documentation to
149+ [ GitHub Pages] ( https://pages.github.com )
149150or bundle them into a release artifact.
150151
151152### Inputs
152153
153154- ` inputs ` :
154155 One or more paths to Swift files in your workspace.
155156 (Default: ` "./Sources" ` )
157+ - ` format ` :
158+ The output format (` "commonmark" ` or ` "html" ` )
159+ (Default: ` "commonmark" ` )
160+ - ` module-name ` :
161+ The name of the module.
156162- ` output ` :
157163 The path for generated output.
158164 (Default: ` "./.build/documentation" ` )
@@ -175,6 +181,7 @@ jobs:
175181 uses : SwiftDocOrg/swift-doc@master
176182 with :
177183 inputs : " Source"
184+ module-name : MyLibrary
178185 output : " Documentation"
179186 - name : Upload Documentation to Wiki
180187 uses : SwiftDocOrg/github-wiki-publish-action@v1
193200Mattt ([@mattt](https://twitter.com/mattt))
194201
195202[ci badge]: https://github.com/SwiftDocOrg/swift-doc/workflows/CI/badge.svg
196-
197203[alamofire wiki]: https://github.com/SwiftDocOrg/Alamofire/wiki
198204[swiftsemantics html]: https://swift-doc-preview.netlify.app
199205[github wiki]: https://help.github.com/en/github/building-a-strong-community/about-wikis
0 commit comments