Skip to content

Commit 1bbf231

Browse files
Use the correct JSDoc annotation syntax for FormField prop descriptions
1 parent 574c53c commit 1bbf231

File tree

1 file changed

+7
-7
lines changed
  • packages/react-components/source/react/library/form

1 file changed

+7
-7
lines changed

packages/react-components/source/react/library/form/FormField.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@ const propTypes = {
1818
label: PropTypes.string.isRequired,
1919
/** The styling of the identifier for this field */
2020
labelType: PropTypes.oneOf(['primary', 'secondary']),
21-
/* Depending on the field, value can be any type */
21+
/** Depending on the field, value can be any type */
2222
// eslint-disable-next-line react/forbid-prop-types
2323
value: PropTypes.any,
2424
/** Form error, causing element to render red when present */
2525
error: PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
2626
/** Expanded explainer for the field */
2727
description: PropTypes.string,
28-
/* Is the field required */
28+
/** Is the field required */
2929
required: PropTypes.bool,
30-
/* The error message to display if the field is required but not present at validation */
30+
/** The error message to display if the field is required but not present at validation */
3131
requiredFieldMessage: PropTypes.string,
32-
/* Should an error message render on load (the rendered msg depends on the presence of required or validator) */
32+
/** Should an error message render on load (the rendered msg depends on the presence of required or validator) */
3333
validateOnLoad: PropTypes.bool,
34-
/* An optional validation function. Will be passed in order: the current field value, and the entire form value */
34+
/** An optional validation function. Will be passed in order: the current field value, and the entire form value */
3535
validator: PropTypes.func,
36-
/* An optional nested path at which to access field data. Nested path can be delimted with `.` or with brackets `[]`. For example: my.nested.array[0] */
36+
/** An optional nested path at which to access field data. Nested path can be delimted with `.` or with brackets `[]`. For example: my.nested.array[0] */
3737
path: PropTypes.string,
38-
/* Alternate inline display format */
38+
/** Alternate inline display format */
3939
inline: PropTypes.bool,
4040
/** Width of the inline label */
4141
inlineLabelWidth: PropTypes.number,

0 commit comments

Comments
 (0)