ref(ui) Improve docs for Form component

static/app/views/settings/components/forms/form.tsx

@@ -22,33 +22,65 @@ type RenderProps = {
 type RenderFunc = (props: RenderProps) => React.ReactNode;
 
 type Props = {
+  /**
+   * The HTTP method to use.
+   */
   apiMethod?: APIRequestMethod;
+  /**
+   * The URL to the API endpoint this form submits to.
+   */
   apiEndpoint?: string;
   children?: React.ReactNode | RenderFunc;
   className?: string;
   cancelLabel?: string;
+  /**
+   * Should the submit button be disabled.
+   */
   submitDisabled?: boolean;
   submitLabel?: string;
   submitPriority?: React.ComponentProps<typeof Button>['priority'];
   footerClass?: string;
   footerStyle?: React.CSSProperties;
   extraButton?: React.ReactNode;
   initialData?: Data;
-  // Require changes before able to submit form
+  /**
+   * Are changed required before the form can be submitted.
+   */
   requireChanges?: boolean;
-  // Reset form when there are errors; after submit
+  /**
+   * Should the form reset its state when there are errors after submission.
+   */
   resetOnError?: boolean;
   hideFooter?: boolean;
   allowUndo?: boolean;
-  // Save field on control blur
+  /**
+   * Should fields save individually as they are blurred.
+   */
   saveOnBlur?: boolean;
+  /**
+   * A FormModel instance. If undefined a FormModel will be created for you.
+   */
   model?: FormModel;
-  // if set to true, preventDefault is not called
+  /**
+   * If set to true, preventDefault is not called
+   */
   skipPreventDefault?: boolean;
   additionalFieldProps?: {[key: string]: any};
   'data-test-id'?: string;
 
+  /**
+   * Callback fired when the form is cancelled via the cancel button.
+   */
   onCancel?: (e: React.MouseEvent) => void;
+  /**
+   * Callback to handle form submission.
+   *
+   * Defining this prop will replace the normal API submission behavior
+   * and instead only call the provided callback.
+   *
+   * Your callback is expected to call `onSubmitSuccess` when the action succeeds and
+   * `onSubmitError` when the action fails.
+   */
   onSubmit?: (
     data: Data,
     onSubmitSuccess: (data: Data) => void,