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

Javadoc @inheritDoc tag support #1608

Merged
merged 2 commits into from Nov 12, 2020
Merged

Javadoc @inheritDoc tag support #1608

merged 2 commits into from Nov 12, 2020

Conversation

MarcinAman
Copy link
Contributor

No description provided.

@MarcinAman MarcinAman linked an issue Nov 9, 2020 that may be closed by this pull request
Javadoc @inheritDoc tag is not handled in HTML output #159
Closed
kamildoleglo
kamildoleglo suggested changes Nov 12, 2020
View reviewed changes
plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt Outdated Show resolved Hide resolved
plugins/base/src/main/kotlin/parsers/MarkdownParser.kt Outdated Show resolved Hide resolved
plugins/base/src/main/kotlin/parsers/MarkdownParser.kt
See(
parseStringToDocNode(content.substringAfter(' ')),
referencedName,
externalDri(referencedName)
dri?.fqName() ?: referencedName,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't referencedName be used by default and the fqname as a fallback?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to have a fq name every time it is possible because:

/**
* @throws RuntimeException sample runtime exception
* @throws java.lang.IllegalStateException another one
*/
void foo()

If we have such a case then it is nice to unify those names to display them accordingly. I'd like to have a fq name since it is most often unique and can be used to distinguish tags, but i am open for discussion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sellophane ?

plugins/base/src/main/kotlin/translators/psi/parsers/InheritDocResolver.kt Outdated Show resolved Hide resolved
core/src/main/kotlin/utilities/safeEnumValueOf.kt Show resolved Hide resolved
plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt Outdated Show resolved Hide resolved
plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt Outdated Show resolved Hide resolved
plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt Outdated Show resolved Hide resolved
plugins/base/src/main/kotlin/translators/psi/parsers/JavadocTag.kt Show resolved Hide resolved
plugins/base/src/test/kotlin/translators/JavadocInheritDocsTest.kt Outdated Show resolved Hide resolved
@MarcinAman MarcinAman merged commit 6a1c05c into master Nov 12, 2020
@MarcinAman MarcinAman deleted the inherit-docs branch November 12, 2020 11:01
This was referenced Mar 16, 2021
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kamildoleglo kamildoleglo kamildoleglo approved these changes

@sellophane sellophane sellophane approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Javadoc @inheritDoc tag is not handled in HTML output
3 participants
@MarcinAman @kamildoleglo @sellophane