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

Scripting: capture structured javadoc from stdlib #68782

Merged

Commits on Feb 9, 2021

  1. Scripting: capture structured javadoc from stdlib

    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 committed Feb 9, 2021
    Copy the full SHA
    2808682 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    583e77c View commit details
    Browse the repository at this point in the history

Commits on Feb 10, 2021

  1. Merge branch 'master' of github.com:elastic/elasticsearch into script…

    …ing/jdk-src-parse-05-clean-at
    stu-elastic committed Feb 10, 2021
    Copy the full SHA
    ded121c View commit details
    Browse the repository at this point in the history