Ionic method parameters are missing descriptions

[brandyscarney]

URL
https://github.com/ionic-team/ionic/tree/master/core/src/components/content#scrollbypointx-number-y-number-duration-number--promisevoid

What is missing or inaccurate about the content on this page?
All of the parameters in Ionic methods are missing descriptions. This should be added like the following:

  /**
   * Scroll by a specified X/Y distance in the component.
   *
   * @param x The amount to scroll on the horizontal axis.
   * @param y The amount to scroll on the vertical axis.
   * @param duration The amount of time it takes to scroll in milliseconds. Defaults to `0`.
   */

It is currently not documented either: https://ionicframework.com/docs/api/content#methods

[brandyscarney]

I'm working on a PR for this in Ionic.

Related to #229.

[brandyscarney]

Added by ionic-team/ionic-framework#18075, just needs to show in the docs

[perrygovier]

This is fixed by the signature section now

[brandyscarney]

The method being documented isn't the problem, it's not knowing what the params mean:

In this specific case they make sense enough to figure it out, but check others like Action Sheet's methods: https://ionicframework.com/docs/api/action-sheet#methods

What is a role? They're documented in the code like the following

  /**
   * Dismiss the action sheet overlay after it has been presented.
   *
   * @param data Any data to emit in the dismiss events.
   * @param role The role of the element that is dismissing the action sheet.
   * This can be useful in a button handler for determining which button was
   * clicked to dismiss the action sheet.
   * Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`.
   */