Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Include public extensions of external types #122

Closed
sindresorhus opened this issue May 21, 2020 · 4 comments
Closed

Include public extensions of external types #122

sindresorhus opened this issue May 21, 2020 · 4 comments
Labels
enhancement New feature or request
Milestone

Comments

@sindresorhus
Copy link

It seems like swift-doc does not include extensions. My project has a NSMenuItem extension, which would be nice to also include. Jazzy correctly includes this.

Screenshot:

Screenshot 2020-05-21 at 15 47 52

Live example: https://sindresorhus.com/KeyboardShortcuts/Extensions/NSMenuItem.html

@mattt
Copy link
Contributor

mattt commented May 23, 2020

That's a great idea. Thanks for pointing this out, @sindresorhus!

@mattt mattt added the enhancement New feature or request label May 23, 2020
@tanner0101
Copy link

tanner0101 commented Aug 5, 2020

+1 this would be very helpful for Vapor's API docs (https://api.vapor.codes). Some of our packages actually consist only of extensions so attempting to generate docs on them fails (https://github.com/vapor/fluent-postgres-driver for example).

@mattt mattt added this to the 1.0.0-beta.5 milestone Aug 5, 2020
@mattt mattt modified the milestones: 1.0.0-beta.5, 1.0.0-beta.6 Sep 25, 2020
@GalenRhodes

This comment has been minimized.

Lukas-Stuehrk added a commit to Lukas-Stuehrk/swift-doc that referenced this issue Mar 27, 2021
Lukas-Stuehrk added a commit to Lukas-Stuehrk/swift-doc that referenced this issue Mar 27, 2021
Lukas-Stuehrk added a commit to Lukas-Stuehrk/swift-doc that referenced this issue Mar 29, 2021
Lukas-Stuehrk added a commit to Lukas-Stuehrk/swift-doc that referenced this issue Mar 30, 2021
@mattt mattt modified the milestones: 1.0.0-beta.6, 1.0.0-rc1 Apr 23, 2021
mattt added a commit that referenced this issue Apr 23, 2021
* Build documentation for external types.

Implements #122.

* Display extensions in definition list

Remove unnecessary style rules for extensions

* Fix false positives for external types.

* Better check for external symbols.

* Refactor isExternalSymbol to perform more general symbol resolution

* Remove unnecessary parameter

* Add resolution for nested types through typealiases

Refactor implementation of ID

* Use typealias resolution when creating relationships

* Add tests for extensions on typealiases.

* Add changelog entry for #230

Co-authored-by: Mattt <[email protected]>
@mattt
Copy link
Contributor

mattt commented Apr 25, 2021

This has been implemented in the latest release (1.0.0-beta.6)

@mattt mattt closed this as completed Apr 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants