[{"_1":2,"_162":-5,"_163":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":21,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":11,"_134":-5,"_135":11,"_136":-5,"_137":138,"_139":91,"_140":-7},"canonicalUrl","https://hub.docker.com/r/applebaumian/swift-doc/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","applebaumian","reponame","swift-doc","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-10-02T21:06:17.198146Z","description","fork of swift-doc","is_private","last_updated","2020-10-02T21:56:10.098683Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",244,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# swift-doc\n\n![CI][ci badge]\n\nA package for generating documentation for Swift projects.\n\nGiven a directory of Swift files,\n`swift-doc` generates HTML or CommonMark (Markdown) files\nfor each class, structure, enumeration, and protocol\nas well as top-level type aliases, functions, and variables.\n\n**Example Output**\n\n- [HTML][swiftsemantics html]\n- [CommonMark / GitHub Wiki][alamofire wiki]\n\n## Requirements\n\n- Swift 5.2\n- [GraphViz][graphviz] _(optional)_\n\n## Command-Line Utility\n\n`swift-doc` can be used from the command-line on macOS and Linux.\n\n### Installation\n\n#### Homebrew\n\nRun the following command to install using [Homebrew](https://brew.sh/):\n\n```terminal\n$ brew install swiftdocorg/formulae/swift-doc\n```\n\n#### Manually\n\nRun the following commands to build and install manually:\n\n```terminal\n$ git clone https://github.com/SwiftDocOrg/swift-doc\n$ cd swift-doc\n$ make install\n```\n\n### Usage\n\n OVERVIEW: A utility for generating documentation for Swift code.\n \n USAGE: swift doc \n \n OPTIONS:\n --version Show the version.\n -h, --help Show help information.\n \n SUBCOMMANDS:\n generate Generates Swift documentation\n coverage Generates documentation coverage statistics for Swift\n files\n diagram Generates diagram of Swift symbol relationships\n\n> **Note**:\n> The `swift` driver provides extensibility through subcommands.\n> If you type an unknown subcommand like `swift foo`,\n> the system looks for a command called `swift-foo` in your `PATH`.\n> This mechanism allows `swift-doc` to be run either directly or as `swift doc`.\n\n#### swift-doc generate\n\n OVERVIEW: Generates Swift documentation\n\n USAGE: swift doc generate [ ...] --module-name [--output ] [--format ] [--base-url ]\n\n ARGUMENTS:\n One or more paths to Swift files \n\n OPTIONS:\n -n, --module-name \n The name of the module \n -o, --output The path for generated output (default:\n .build/documentation)\n -f, --format The output format (default: commonmark)\n --base-url The base URL used for all relative URLs in generated\n documents. (default: /)\n -h, --help Show help information.\n\nThe `generate` subcommand \ntakes one or more paths and enumerates them recursively,\ncollecting all Swift files into a single \"module\"\nand generating documentation accordingly.\n\n```terminal\n$ swift doc generate path/to/SwiftProject/Sources --module-name SwiftProject\n$ tree .build/documentation\n$ documentation/\n├── Home\n├── (...)\n├── _Footer.md\n└── _Sidebar.md\n```\n\nBy default,\noutput files are written to `.build/documentation`\nin CommonMark / GitHub Wiki format,\nbut you can change that with the `--output` and `--format` option flags.\n\n```terminal\n$ swift doc generate path/to/SwiftProject/Sources --module-name SwiftProject --output Documentation --format html\n$ Documentation/\n├── (...)\n└── index.html\n```\n\n#### swift-doc coverage\n\n OVERVIEW: Generates documentation coverage statistics for Swift files\n\n USAGE: swift doc coverage [ ...] [--output ]\n\n ARGUMENTS:\n One or more paths to Swift files \n\n OPTIONS:\n -o, --output The path for generated report \n -h, --help Show help information.\n\nThe `coverage` subcommand\ngenerates documentation coverage statistics for Swift files.\n\n```terminal\n$ git clone https://github.com/SwiftDocOrg/SwiftSemantics.git\n\n$ swift run swift-doc coverage SwiftSemantics/Sources --output \"dcov.json\"\n$ cat dcov.json | jq \".data.totals\"\n{\n \"count\": 207,\n \"documented\": 199,\n \"percent\": 96.1352657004831\n}\n\n$ cat dcov.json | jq \".data.symbols[] | select(.documented == false)\"\n{\n \"file\": \"SwiftSemantics/Supporting Types/GenericRequirement.swift\",\n \"line\": 67,\n \"column\": 6,\n \"name\": \"GenericRequirement.init?(_:)\",\n \"type\": \"Initializer\",\n \"documented\": false\n}\n...\n```\n\nWhile there are plenty of tools for assessing test coverage for code,\nwe weren't able to find anything analogous for documentation coverage.\nTo this end,\nwe've contrived a simple JSON format\n[inspired by llvm-cov](https://reviews.llvm.org/D22651#change-xdePaVfBugps).\n\nIf you know of an existing standard\nthat you think might be better suited for this purpose,\nplease reach out by [opening an Issue][open an issue]!\n\n#### swift-doc diagram\n\n OVERVIEW: Generates diagram of Swift symbol relationships\n\n USAGE: swift doc diagram [ ...]\n\n ARGUMENTS:\n One or more paths to Swift files \n\n OPTIONS:\n -h, --help Show help information.\n\nThe `diagram` subcommand\ngenerates a graph of APIs in [DOT format][dot]\nthat can be rendered by [GraphViz][graphviz] into a diagram.\n\n```terminal\n$ swift run swift-doc diagram Alamofire/Source > Alamofire.gv\n$ head Alamofire.gv\ndigraph Anonymous {\n \"Session\" [shape=box];\n \"NetworkReachabilityManager\" [shape=box];\n \"URLEncodedFormEncoder\" [shape=box,peripheries=2];\n \"ServerTrustManager\" [shape=box];\n \"MultipartFormData\" [shape=box];\n\n subgraph cluster_Request {\n \"DataRequest\" [shape=box];\n \"Request\" [shape=box];\n\n$ dot -T svg Alamofire.gv > Alamofire.svg\n```\n\nHere's an excerpt of the graph generated for Alamofire:\n\n![Excerpt of swift-doc-api Diagram for Alamofire](https://user-images.githubusercontent.com/7659/73189318-0db0e880-40d9-11ea-8895-341a75ce873c.png)\n\n## GitHub Action\n\nThis repository also hosts a [GitHub Action][github actions]\nthat you can incorporate into your project's workflow.\n\nThe CommonMark files generated by `swift-doc`\nare formatted for publication to your project's [GitHub Wiki][github wiki],\nwhich you can do with\n[github-wiki-publish-action][github-wiki-publish-action].\nAlternatively,\nyou could specify HTML format to publish documentation to\n[GitHub Pages](https://pages.github.com)\nor bundle them into a release artifact.\n\n### Inputs\n\n- `inputs`:\n A path to a directory containing Swift (`.swift`) files in your workspace.\n (Default: `\"./Sources\"`)\n- `format`:\n The output format (`\"commonmark\"` or `\"html\"`)\n (Default: `\"commonmark\"`)\n- `module-name`:\n The name of the module.\n- `base-url`:\n The base URL for all relative URLs generated in documents.\n (Default: `\"/\"`)\n- `output`:\n The path for generated output.\n (Default: `\"./.build/documentation\"`)\n\n### Example Workflow\n\n```yml\n# .github/workflows/documentation.yml\nname: Documentation\n\non: [push]\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v1\n - name: Generate Documentation\n uses: SwiftDocOrg/swift-doc@master\n with:\n inputs: \"Sources\"\n module-name: MyLibrary\n output: \"Documentation\"\n - name: Upload Documentation to Wiki\n uses: SwiftDocOrg/github-wiki-publish-action@v1\n with:\n path: \"Documentation\"\n env:\n GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}\n```\n\n## Development\n\n### Web Assets\n\nCSS assets used by the HTML output format\nare processed and generated by [PostCSS](https://postcss.org).\nTo make changes to these assets,\nyou'll need to have [Node.js](https://nodejs.org/en/)\nand a package manager, such as [`npm`](https://www.npmjs.com),\ninstalled on your machine.\n\nNavigate to the `.node` directory\nand run `npm install` to download the required tools and libraries.\n\n```terminal\n$ cd .node\n$ npm install\n```\n\n> **Note**:\n> `package.json` is located at a hidden `.node` subdirectory\n> to prevent Xcode from displaying or indexing the contents of `node_modules`\n> when opening the main project.\n\nFrom the `.node` directory,\nrun the `watch` script\nto start watching for changes to files in the `Assets` folder.\nWhenever an asset source file is added, removed, or updated,\nits corresponding (unoptimized) product is automatically generated\nin the `Resources` folder.\n\n```terminal\n$ npm run watch\n```\n\nWhen you're happy with the results,\ncommit any changes to the source files in `Assets`\nas well as the generated files in `Resources`.\n\n```terminal\n$ git add Assets Resources\n$ git commit\n```\n\n## Release Process\n\n> The following information is primarily for the benefit of project maintainers.\n> That said, if you have any suggestions for how to improve this process,\n> please let us know by [opening an issue][open an issue].\n\nFollow these steps to release a new version of `swift-doc`:\n\n- [x] Verify that the latest commit\n [passed all CI checks](https://github.com/SwiftDocOrg/swift-doc/actions?query=workflow%3ACI).\n- [x] Update the Changelog by creating a new heading for the release\n and modifying the last path component for the `unreleased` link reference.\n- [x] Update the [`version` constant](https://github.com/SwiftDocOrg/swift-doc/blob/master/Sources/swift-doc/main.swift#L25)\n in the command-line executable.\n- [x] Create a new commit with the message \"Bump version to `$VERSION`\",\n where `$VERSION` is a [SemVer]-compatible version number.\n- [x] Tag that commit with the tag name \"`$VERSION`\"\n- [x] Run the command `git push origin master --tags`\n- [x] Create a new [release](https://github.com/SwiftDocOrg/swift-doc/releases)\n that corresponds to the new tag.\n\n## License\n\nMIT\n\n## Contact\n\nMattt ([@mattt](https://twitter.com/mattt))\n\n[ci badge]: https://github.com/SwiftDocOrg/swift-doc/workflows/CI/badge.svg\n[alamofire wiki]: https://github.com/SwiftDocOrg/Alamofire/wiki\n[swiftsemantics html]: https://swift-doc-preview.netlify.app\n[github wiki]: https://help.github.com/en/github/building-a-strong-community/about-wikis\n[github actions]: https://github.com/features/actions\n[swiftsyntax]: https://github.com/apple/swift-syntax\n[swiftsemantics]: https://github.com/SwiftDocOrg/SwiftSemantics\n[swiftmarkup]: https://github.com/SwiftDocOrg/SwiftMarkup\n[commonmark]: https://github.com/SwiftDocOrg/CommonMark\n[github-wiki-publish-action]: https://github.com/SwiftDocOrg/github-wiki-publish-action\n[open an issue]: https://github.com/SwiftDocOrg/swift-doc/issues/new\n[jazzy]: https://github.com/realm/jazzy\n[swift number protocols diagram]: https://nshipster.com/propertywrapper/#swift-number-protocols\n[protocol-oriented programming]: https://asciiwwdc.com/2015/sessions/408\n[apple documentation]: https://developer.apple.com/documentation\n[se-0195]: https://github.com/apple/swift-evolution/blob/master/proposals/0195-dynamic-member-lookup.md\n[se-o258]: https://github.com/apple/swift-evolution/blob/master/proposals/0258-property-wrappers.md\n[se-xxxx]: https://github.com/apple/swift-evolution/blob/9992cf3c11c2d5e0ea20bee98657d93902d5b174/proposals/XXXX-function-builders.md\n[swiftdoc.org]: https://swiftdoc.org\n[jazzy swiftsemantics]: https://swift-semantics-jazzy.netlify.com\n[swift-doc swiftsemantics]: https://github.com/SwiftDocOrg/SwiftSemantics/wiki\n[@natecook1000]: https://github.com/natecook1000\n[nshipster]: https://nshipster.com\n[dependency hell]: https://github.com/apple/swift-package-manager/tree/master/Documentation#dependency-hell\n[pcre]: https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions\n[dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language)\n[graphviz]: https://www.graphviz.org\n[semver]: https://semver.org\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",282784635,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",5913629,"full_size",222013204,"id",119899147,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:6f7f7a317a292bba66924e24c02fa08ce20220871e273d58159a6a2cb2e7b51a","features","","last_pulled","2026-10-19T21:44:01.222686499Z","last_pushed","2020-10-02T21:56:10Z","os","linux","os_features","os_version","size","variant","2020-10-02T21:56:09.402111Z","last_updater","last_updater_username","media_type","latest","repository",9953764,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":143,"_150":151,"_137":160,"_161":11},{"_40":144,"_42":145,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":146,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":147,"_79":11,"_80":149,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":148},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_152":64,"_153":-5,"_154":-5,"_155":156},"count","next","previous","results",[157],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":158,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[159],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

applebaumian/swift-doc

Tags for applebaumian/swift-doc