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

The Gradle Documentation Generator should support @apiNote, @implSpec and @implNote #7486

Open
JLLeitschuh opened this issue Oct 22, 2018 · 5 comments

Comments

@JLLeitschuh
Copy link
Contributor

https://blog.codefx.org/java/new-javadoc-tags/

As a contributor, it would be nice to be able to use the @implSpec annotation in a JavaDoc inside of Gradle so I can use {@link} and <a href="...">something</a> inside of documentation that I want for other contributors, but I don't want to end up in the generated Javadocs that are published.

Example usecase: #7435 (comment)

@eriwen

@sinistersnare
Copy link

Is there news on Gradle support for these tags?

@big-guy big-guy added this to the Unscheduled milestone Feb 5, 2019
@big-guy
Copy link
Member

big-guy commented Feb 5, 2019

@sinistersnare This issue is about the Gradle documentation generator (for https://docs.gradle.org/current/dsl/index.html), not documentation in general.

@martinandersson
Copy link

Guys, 2.5 years have passed. Let's go =)

@JLLeitschuh
Copy link
Contributor Author

To reiterate, this doesn't impact Gradle's javadocc generation. This impacts Gradle's internal documentation generator.

@jjohannes jjohannes removed this from the Unscheduled milestone Mar 19, 2021
@stale
Copy link

stale bot commented Apr 13, 2022

This issue has been automatically marked as stale because it has not had recent activity. Given the limited bandwidth of the team, it will be automatically closed if no further activity occurs. If you're interested in how we try to keep the backlog in a healthy state, please read our blog post on how we refine our backlog. If you feel this is something you could contribute, please have a look at our Contributor Guide. Thank you for your contribution.

@stale stale bot added the stale label Apr 13, 2022
@ov7a ov7a added the a:feature A new functionality label Sep 5, 2023
@ov7a ov7a removed the in:building-gradle gradle/gradle build label Mar 14, 2024
@lkasso lkasso linked a pull request Apr 7, 2024 that will close this issue
@lkasso lkasso self-assigned this Apr 7, 2024
@lkasso lkasso removed a link to a pull request Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants