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

Java package annotations #2330

Closed
ember-rose opened this issue Jan 26, 2022 · 0 comments · Fixed by #2331
Closed

Java package annotations #2330

ember-rose opened this issue Jan 26, 2022 · 0 comments · Fixed by #2331
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs

Comments

@ember-rose
Copy link
Contributor

Describe the bug
DefaultDocumentableToPsiTranslator does not load Java package annotations.

Expected behaviour
Java package annotations should be parsed into the associated DPackage. As described in JLS §7.4.1, only one package declaration per package may be annotated, and the spec recommends placing it in package-info.java. For Dokka's purposes, checking package-info.java for package annotations should be sufficent.

To Reproduce
Observe that package annotations are missing from a the DPackage produced from a project containing a package like:

// test/pkg/package-info.java

@PackageAnnotation
package test.pkg;

Installation

  • Operating system: Linux
  • Build tool: Gradle v7.3
  • Dokka version: 1.6.10-dev-139

Are you willing to provide a PR?
Yes
@ember-rose ember-rose added the bug label Jan 26, 2022
@IgnatBeresnev IgnatBeresnev added the feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs label Jan 26, 2022
ember-rose added a commit to ember-rose/dokka that referenced this issue Jan 26, 2022
@ember-rose
Collect annotations from package-info.java
7fdd903 
Fix: Kotlin#2330
@ember-rose ember-rose mentioned this issue Jan 26, 2022
Merged
IgnatBeresnev pushed a commit that referenced this issue Jan 27, 2022
@ember-rose
Collect annotations from package-info.java (#2331)
066c551 
Fix: #2330
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug feedback: Google An issue/PR submitted by colleagues at Google, most likely related to the Android API reference docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Collect annotations from package-info.java ember-rose/dokka
2 participants
@IgnatBeresnev @ember-rose