Skip to content

Commit

Permalink
jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
mwarman committed Jul 11, 2024
1 parent ccc1ad5 commit 23686fa
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 3 deletions.
9 changes: 8 additions & 1 deletion src/pages/Users/components/UserDetail/AddressDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,14 @@ interface AddressDetailProps extends BaseComponentProps {
* The `AddressDetail` component renders a block which displays a single
* `Address`.
*
* If the `address` property is null or undefined, a loading state is rendered.
* If `isLoading` is `true` the loading state is rendered.
*
* If `isLoading` is `false` and the `address` property is provided, the
* address attributes are rendered.
*
* If `isLoading` is `false` and the `address` property is empty, the
* component returns `false` so that the component remains in the React
* hierarchy, but does not render anything.
*
* @param {AddressDetailProps} props - Component properties.
* @returns {JSX.Element | false} Returns JSX when loading or a user is
Expand Down
9 changes: 8 additions & 1 deletion src/pages/Users/components/UserDetail/CompanyDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,14 @@ interface CompanyDetailProps extends BaseComponentProps {
* The `CompanyDetail` component renders a block which provides details about
* a single `Company`.
*
* If the `company` property is null or undefined, a loading state is rendered.
* If `isLoading` is `true` the loading state is rendered.
*
* If `isLoading` is `false` and the `company` property is provided, the
* company attributes are rendered.
*
* If `isLoading` is `false` and the `company` property is empty, the
* component returns `false` so that the component remains in the React
* hierarchy, but does not render anything.
*
* @param {CompanyDetailProps} props - Component properties.
* @returns {JSX.Element | false} Returns JSX when loading or a user is
Expand Down
9 changes: 8 additions & 1 deletion src/pages/Users/components/UserDetail/UserSummary.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@ interface UserSummaryProps extends BaseComponentProps {
* The `UserSummary` component renders a block containing summary information
* about a single `User` including their name, email, phone, and website.
*
* If the supplied `user` is null or undefined, a loading state is rendered.
* If `isLoading` is `true` the loading state is rendered.
*
* If `isLoading` is `false` and the `user` property is provided, the
* user attributes are rendered.
*
* If `isLoading` is `false` and the `user` property is empty, the
* component returns `false` so that the component remains in the React
* hierarchy, but does not render anything.
*
* @param {UserSummaryProps} props - Component propertiers.
* @returns {JSX.Element | false} Returns JSX when loading or a user is
Expand Down

0 comments on commit 23686fa

Please sign in to comment.