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.

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

extension type's constructor parameter gets a symbol but no documentation can be attached to it #3830

Open
isoos opened this issue Aug 9, 2024 · 2 comments
Labels
P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@isoos
Copy link
Contributor

isoos commented Aug 9, 2024

The latest 8.0.13 (and earlier versions) have this result, originally reported at dart-lang/pana#1393

extension type const Celsius(

    /// This text is not in the dartdoc output.
    num degrees) implements num {
}

Celsius.degrees gets into the output both as file (<library>/Celsius/degrees.html) and as part of the searchable API symbols JSON.
Either we shouldn't get a separate symbol, or it should be able to provide some kind of documentation (like in the above case).

Alternatively: is there any way we could detect these symbols just by parsing the JSON file?

@keertip keertip added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P2 A bug or feature request we're likely to work on labels Aug 12, 2024
@srawlins srawlins transferred this issue from dart-lang/dartdoc Aug 12, 2024
@srawlins srawlins removed the P2 A bug or feature request we're likely to work on label Aug 12, 2024
@srawlins
Copy link
Member

Dartdoc cannot do anything here because neither the RepresentationDeclaration nor any of it's child nodes can have a documentation comment. I've moved this issue to the SDK repo.

@srawlins srawlins transferred this issue from dart-lang/sdk Aug 12, 2024
@srawlins
Copy link
Member

Sorry, I didn't read the description closely enough 😊 . Sounds like a dartdoc issue.

@keertip keertip added the P2 A bug or feature request we're likely to work on label Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 A bug or feature request we're likely to work on type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

3 participants