swift-doc
swift-doc copied to clipboard
SwiftDocOrg
A documentation generator for Swift projects
Example: ``` protocol InternalProtocol {} public class PublicClass: InternalProtocol { } ``` Documentation for `PublicClass` is generated with inheritance section which points out to `InternalProtocol` which links to file which...
Some parts of the code base were still using the former logic from before we introduced the `--minimum-access-level` flag. This pull request will clean up all those usages and switch...
Hi! I believe there is an error generating the path to the 'all.css' file. A '/' is being placed at the very beginning, and this is not allowing it to...
This adds abstractions to remove much of the boilerplate code needed for generating end-to-end tests for the `generate` subcommand. It will make it easy to add regression tests in the...
Why does the script take into consideration public overrides and protocol conformances during analysis?
After a quick look at `action.yml` I'm not sure if it's possible to use the action just for documentation coverage checks? It would be great to use the action to...
I welcome feedback on anything, specifically: * Position and style of theme picker * The use of TypeScript - I chose it because I'm familiar and like type safety, but...
would be great to add this to swift-doc. jazzy hides declarations commented with `:nodoc:` [like this](https://github.com/realm/jazzy/search?q=nodoc) ```swift def self.should_document?(doc) return false if doc['key.doc.comment'].to_s.include?(':nodoc:') ```
I was really excited when I came across this project, but quickly realized generated HTML files can't be browsed locally. In looking at issues I came across this: https://github.com/SwiftDocOrg/swift-doc/issues/25#issuecomment-609439333 The...
Is there a way to generate html groups like with Doxygen 's @defgroup and @ingroup ? It would be great for us!
Metadata
Owner
Metadata
A documentation generator for Swift projects