swift-doc

swift-doc copied to clipboard

Add availabilityAttributes property to Symbol

2

This is to partially support #105 and the `@available` attributes. ### AvailabilityAttribute I've added a property to `Symbol` called `availabilityAttributes` to support any attributes that are on the Symbol. `SwiftSemantics`...

MattKiazyk

Use a wider default style

3

Swift-doc really doesn't do a good job of using all of the available space.  As a result, it tends to be very uncomfortable to read (at least for me)....

karwa

Currently, long type names can overflow boxes in hierarchy diagrams.

mattt

Given the following types: ```swift enum Namespace { struct A { /// - Returns: A `B`. func b() -> B { B() } } struct B { /// - Returns:...

slashmo

A project I'm working on makes use of `@_specialize` as an alternative to inlining in certain circumstances. It can be a really great tool for getting the best performance with...

karwa

Related to #235, it would be nice if nested types would be linked to: ```swift enum Namespace { struct A {} } /// - Returns a `Namespace.A`. func example() ->...

slashmo

Related subtasks: - [ ] Create a `v1` branch Document how to use a tagged release for consistent builds - [ ] Create a workflow that triggers on tags to...

mattt

Show the version number

1

The docs site should show the current version (Git tag) of the project. Before: After:

sindresorhus

It would be nice if each type had a "View Source" link (could be on hover or in a `…` menu) that linked to its source (with the correct SHA...

sindresorhus

Add link to the GitHub repo

2

I would like to have a link back to the GitHub repo from the docs. Jazzy automatically shows a link in the top-right corner of the docs site if you...

sindresorhus