Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SR-1161] Allow Cross-References in Documentation Markup #43769

Open
swift-ci opened this issue Apr 5, 2016 · 2 comments
Open

[SR-1161] Allow Cross-References in Documentation Markup #43769

swift-ci opened this issue Apr 5, 2016 · 2 comments
Labels
bug A deviation from expected or documented behavior. Also: expected but undesirable behavior.

Comments

@swift-ci
Copy link
Collaborator

swift-ci commented Apr 5, 2016

Previous ID SR-1161
Radar None
Original Reporter deggert (JIRA User)
Type Bug

Attachment: Download

Additional Detail from JIRA
Votes 3
Component/s Source Tooling
Labels Bug
Assignee None
Priority Medium

md5: 297043c1e3dc934f57f9c64897e8197c

Issue Description:

This renders, but Xcode doesn't link to the other one:

/// My Struct A
/// - SeeAlso: `B`
struct A {
}

/// My Struct B
/// - SeeAlso: `A`
struct B {
}

I'd expect the rendered documentation to have a link to the other struct.
@swift-ci
Copy link
Collaborator Author

Comment by Jason R Tibbetts (JIRA)

In Xcode 11, `- SeeAlso:` appears to be ignored completely in option-click popups. It doesn't even show up as part of the regular description; it's ignored completely.

    /// The description.
    ///
    /// # See also: AVPlayerController.load(playerItem:)
    /// - SeeAlso: This line doesn't appear
    /// - seeAlso: Neither does this one.
    /// - seealso: Case doesn't matter.
    open func load(playerItem: AVPlayerItem) {
        player?.load(playerItem: playerItem)
    }

![](Screen Shot 2020-06-15 at 11.45.53 AM.png)

@swift-ci
Copy link
Collaborator Author

Comment by Jason R Tibbetts (JIRA)

One workaround that StackOverflow suggests is to use a # Markdown header element, but headers can't include `code`, so that's suboptimal.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug A deviation from expected or documented behavior. Also: expected but undesirable behavior.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@swift-ci