Scripting: capture structured javadoc from stdlib #68782
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clean javadoc tags and strip html.
Methods and constructors have an optional `javadoc` field. All fields under
`javadoc` are optional but at least one will be present.
Fields also have optional `javadoc` field which, if present, is a string.
```
"javadoc": {
"description": "...",
// from @param <param name> <param description>
"parameters": {
"p1": "<p1 description>",
"p2": "<p2 description>"
},
// from @return
"return": "...",
// from @throws <type> <description>
"throws": [
[
"IndexOutOfBoundsException",
"<description>"
],
[
"IOException",
"<description>"
]
]
}
```
stu-elastic
added
>enhancement
:Core/Infra/Scripting
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
stu-elastic
force-pushed
the
scripting/jdk-src-parse-05-clean-at
branch
from
6149747
to
2808682
Compare
jdconrad
approved these changes
Feb 9, 2021
| @@ -77,13 +77,15 @@ dependencies { | |||
| docImplementation project(':server') | |||
| docImplementation project(':modules:lang-painless') | |||
| docImplementation 'com.github.javaparser:javaparser-core:3.18.0' | |||
| docImplementation 'org.jsoup:jsoup:1.13.1' | |||
There was a problem hiding this comment.
It's used to clean html tags.
| ParsedJavadoc parsed = new ParsedJavadoc(cleaned(cleaned)); | ||
| for (JavadocBlockTag tag: tags) { | ||
| String tagName = tag.getTagName(); | ||
| // https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags |
There was a problem hiding this comment.
Did you intend to link to Java 7 for this comment?
There was a problem hiding this comment.
Updated to java14.
…ing/jdk-src-parse-05-clean-at
stu-elastic
added a commit
to stu-elastic/elasticsearch
that referenced
this pull request
Feb 10, 2021
Clean javadoc tags and strip html.
Methods and constructors have an optional `javadoc` field. All fields under
`javadoc` are optional but at least one will be present.
Fields also have optional `javadoc` field which, if present, is a string.
```
"javadoc": {
"description": "...",
// from @param <param name> <param description>
"parameters": {
"p1": "<p1 description>",
"p2": "<p2 description>"
},
// from @return
"return": "...",
// from @throws <type> <description>
"throws": [
[
"IndexOutOfBoundsException",
"<description>"
],
[
"IOException",
"<description>"
]
]
}
```
Backport: c35eebe
stu-elastic
added a commit
that referenced
this pull request
Feb 16, 2021
* Scripting: capture structured javadoc from stdlib (#68782) Clean javadoc tags and strip html. Methods and constructors have an optional `javadoc` field. All fields under `javadoc` are optional but at least one will be present. Fields also have optional `javadoc` field which, if present, is a string. ``` "javadoc": { "description": "...", // from @param <param name> <param description> "parameters": { "p1": "<p1 description>", "p2": "<p2 description>" }, // from @return "return": "...", // from @throws <type> <description> "throws": [ [ "IndexOutOfBoundsException", "<description>" ], [ "IOException", "<description>" ] ] } ``` Backport: c35eebe
easyice
pushed a commit
to easyice/elasticsearch
that referenced
this pull request
Mar 25, 2021
Clean javadoc tags and strip html.
Methods and constructors have an optional `javadoc` field. All fields under
`javadoc` are optional but at least one will be present.
Fields also have optional `javadoc` field which, if present, is a string.
```
"javadoc": {
"description": "...",
// from @param <param name> <param description>
"parameters": {
"p1": "<p1 description>",
"p2": "<p2 description>"
},
// from @return
"return": "...",
// from @throws <type> <description>
"throws": [
[
"IndexOutOfBoundsException",
"<description>"
],
[
"IOException",
"<description>"
]
]
}
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clean javadoc tags and strip html.
Methods and constructors have an optional
javadocfield. All fields underjavadocare optional but at least one will be present.Fields also have optional
javadocfield which, if present, is a string.