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

Move text under @depracation tag to Deprecation block in Java sources #2668

Open
atyrin opened this issue Sep 13, 2022 · 1 comment · May be fixed by #3421
Open

Move text under @depracation tag to Deprecation block in Java sources #2668

atyrin opened this issue Sep 13, 2022 · 1 comment · May be fixed by #3421
Assignees
@berezinant
Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format html: backend An issue/PR that affects the HTML format, but requires changes in common (content) Kotlin code language: Java Issue/PR related to the Java language feature/analysis/docs topic: frontend onboarding An issue that could be used to onboard team members specializing in frontend development

Comments

@atyrin
Copy link
Contributor

atyrin commented Sep 13, 2022

For the Java code like:

public class DeprecatedJClass {
    /**
     * Don't do anything
     * @deprecated
     * This method is no longer acceptable to compute time between versions.
     * <p> Use {@link DeprecatedJClass#getStringMethodNew()} instead.
     */
    @Deprecated(since = "18.0.2", forRemoval = true)
    public void getStringMethod(){}
    public void getStringMethodNew(){}
}

The HTML output look like:
image

It seems like it would be nice to move the text from the Depreciation paragraph to the Deracation table to have everything in one place.
@atyrin atyrin added enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format labels Sep 13, 2022
@IgnatBeresnev IgnatBeresnev added the language: Java Issue/PR related to the Java language feature/analysis/docs label Mar 8, 2023
@IgnatBeresnev IgnatBeresnev added the html: backend An issue/PR that affects the HTML format, but requires changes in common (content) Kotlin code label Oct 20, 2023
@IgnatBeresnev IgnatBeresnev added the topic: frontend onboarding An issue that could be used to onboard team members specializing in frontend development label Nov 23, 2023
@IgnatBeresnev
Copy link
Member

  • It's likely that @berezinant will tackle this problem as part of his onboarding. It's a good issue because it deals with the common content layer, but the result is visible in HTML
  • I'll help, we'll do pair programming

@IgnatBeresnev IgnatBeresnev linked a pull request Dec 19, 2023 that will close this issue
Draft
@IgnatBeresnev IgnatBeresnev removed their assignment Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@berezinant berezinant

Labels
enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format html: backend An issue/PR that affects the HTML format, but requires changes in common (content) Kotlin code language: Java Issue/PR related to the Java language feature/analysis/docs topic: frontend onboarding An issue that could be used to onboard team members specializing in frontend development
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Display Java's Deprecated message Kotlin/dokka
3 participants
@berezinant @atyrin @IgnatBeresnev