swift-doc
swift-doc copied to clipboard
SwiftDocOrg
A documentation generator for Swift projects
As suggested by @MaxDesiatov in #57: > It would be great if there was an option not just to include README.md, but a given directory hierarchy of multiple markdown files...
Most projects provide a helpful overview in their README, and it'd be nice to include that in the generated HTML documentation. This requires a new, optional parameter for the `generate`...
Right now, swift-doc does a syntactic parse over any source files globbed from the input argument. With #31, it'll be much easier to sort things out and understand how symbols...
It's possible to have functions, methods, operators etc. with the same names, but different types. One example would be the following class declaration: ```swift public class SomeClass { public func...
It would be great if SwiftDoc's generated docs could inherit the inline documentation for protocol implementations and overrides. For example, Alamofire has a `SessionDelegate` type which implements the various `URLSession*Delegate`...
One of the consequences of #65 is that we now have an option that applies to HTML output, but not CommonMark. This kind of divergence isn't unexpected — certainly, as...
This can be useful for multiple purposes: - Adding analytics - Quickly modifying the docs site with some quick JS/CSS - Dynamically adding some extra content Jazzy solves this with...
When you subclass a class, you sometimes have to implement some required methods or you want to override a property. These have to be marked as `public`, and hence shows...
Currently, swift-doc builds a symbol graph syntactically. However, this approach has limitations (#25, #16). We may want to keep the current, syntactic approach around as an option for quick-and-dirty doc...
If a public type is named `Home`, `_Sidebar`, or `_Footer`, its generated documentation would be overwritten by the special page of the same name. We should add logic in the...
Metadata
Owner
Metadata
A documentation generator for Swift projects