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

@inheritDoc and @code don't work well together #4048

Open
juliamcclellan opened this issue Mar 3, 2025 · 0 comments
Open

@inheritDoc and @code don't work well together #4048

juliamcclellan opened this issue Mar 3, 2025 · 0 comments
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs

Comments

@juliamcclellan
Copy link
Contributor

Describe the bug
Java source:

/*
 * {@code inherited code}
 */
public class Parent Class {}

/**
  * {@inheritDoc}
  */
public class ChildClass extends ParentClass {}

The documentation attached to the DClass for ChildClass does not have a CodeInline element, and the text is "inherited code}" with a trailing curly.

(Full documentation element copied from debugger: Description(root=CustomDocTag(children=[P(children=[Text(body=inherited code}, children=[], params={})], params={})], params={}, name=MARKDOWN_FILE)))

Expected behaviour
The documentation for ChildClass should be the same as it is for ParentClass, containing a CodeInline element with text "inherited code" (no trailing curly).

(Full documentation of ParentClass copied from debugger: Description(root=CustomDocTag(children=[P(children=[CodeInline(children=[Text(body=inherited code, children=[], params={})], params={})], params={})], params={}, name=MARKDOWN_FILE)))

Dokka configuration
This is using dokka 2.0.20-dev-337

@whyoleg whyoleg added the feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs label Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs
Projects
None yet
Development

No branches or pull requests

2 participants