Skip to content
This repository has been archived by the owner on Sep 18, 2023. It is now read-only.

Commit

Permalink
docs: correct esdoc module names (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbolel authored Jun 1, 2023
1 parent a8d9d9c commit fd257d3
Show file tree
Hide file tree
Showing 82 changed files with 87 additions and 86 deletions.
2 changes: 1 addition & 1 deletion src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* The main component that renders all routes in the application.
* @module @sbom-harbor-ui/dashboard/Main
* @module sbom-harbor-ui/Main
*/
import { Outlet } from 'react-router-dom'
import { ThemeProvider } from '@mui/material/styles'
Expand Down
2 changes: 1 addition & 1 deletion src/actions/actionTypes.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module actions
* @module sbom-harbor-ui/actions/actionTypes
* @description dispatch action types.
*/

Expand Down
2 changes: 1 addition & 1 deletion src/actions/loginUser.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/actions/loginUser
* @module sbom-harbor-ui/actions/loginUser
*/
import React from 'react'
import { Auth } from 'aws-amplify'
Expand Down
2 changes: 1 addition & 1 deletion src/actions/logoutUser.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/actions/logoutUser
* @module sbom-harbor-ui/actions/logoutUser
*/
import { Auth } from 'aws-amplify'
import React from 'react'
Expand Down
2 changes: 1 addition & 1 deletion src/api/createToken.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/api/createToken
* @module sbom-harbor-ui/api/createToken
*/
import harborRequest from '@/utils/harborRequest'

Expand Down
2 changes: 1 addition & 1 deletion src/api/deleteToken.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/api/deleteToken
* @module sbom-harbor-ui/api/deleteToken
*/
import harborRequest from '@/utils/harborRequest'

Expand Down
2 changes: 1 addition & 1 deletion src/api/getUsersSearch.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/api/getUsersSearch
* @module sbom-harbor-ui/api/getUsersSearch
*/
import { Auth } from 'aws-amplify'
import { CONFIG } from '@/utils/constants'
Expand Down
2 changes: 1 addition & 1 deletion src/api/updateTeam.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/api/updateTeam
* @module sbom-harbor-ui/api/updateTeam
*/
import harborRequest from '@/utils/harborRequest'
import { FormState } from '@/views/Dashboard/Team/types'
Expand Down
2 changes: 1 addition & 1 deletion src/api/updateToken.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/api/updateToken
* @module sbom-harbor-ui/api/updateToken
*/
import harborRequest from '@/utils/harborRequest'

Expand Down
2 changes: 1 addition & 1 deletion src/api/uploadSBOM.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Function that makes a request to the Harbor API.
* @module @sbom-harbor-ui/dashboard/api/harborRequest
* @module sbom-harbor-ui/api/harborRequest
*/
import harborRequest from '@/utils/harborRequest'

Expand Down
2 changes: 1 addition & 1 deletion src/components/AlertMessage.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* An alert message component.
* @module @sbom-harbor-ui/dashboard/components/AlertMessage
* @module sbom-harbor-ui/components/AlertMessage
*/
import Alert from '@mui/material/Alert'
import Box from '@mui/material/Box'
Expand Down
2 changes: 1 addition & 1 deletion src/components/AppBar.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/components/AppBar
* @module sbom-harbor-ui/components/AppBar
*/
import { styled } from '@mui/material/styles'
import MuiAppBar, { AppBarProps as MuiAppBarProps } from '@mui/material/AppBar'
Expand Down
2 changes: 1 addition & 1 deletion src/components/AppDrawer.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/components/AppDrawer
* @module sbom-harbor-ui/components/AppDrawer
*/
import { styled } from '@mui/material/styles'
import MuiDrawer from '@mui/material/Drawer'
Expand Down
2 changes: 1 addition & 1 deletion src/components/AppDrawerButton.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/views/App/AppDrawerListItems
* @module sbom-harbor-ui/views/App/AppDrawerListItems
*/
import { Link as RouterLink } from 'react-router-dom'
import Link from '@mui/material/Link'
Expand Down
2 changes: 1 addition & 1 deletion src/components/Copyright.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Copyright component used in the footer.
* @module @sbom-harbor-ui/dashboard/components/Copyright
* @module sbom-harbor-ui/components/Copyright
*/
import Link from '@mui/material/Link'
import Typography, { TypographyProps } from '@mui/material/Typography'
Expand Down
2 changes: 1 addition & 1 deletion src/components/DateLocaleString.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/DateLocaleString
* @module sbom-harbor-ui/hooks/DateLocaleString
*/
import Typography from '@mui/material/Typography'

Expand Down
2 changes: 1 addition & 1 deletion src/components/ErrorBoundary.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Generic React error boundary component.
* @module @sbom-harbor-ui/dashboard/components/ErrorBoundary
* @module sbom-harbor-ui/components/ErrorBoundary
*/
import {
isRouteErrorResponse,
Expand Down
2 changes: 1 addition & 1 deletion src/components/Footer.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Sticky footer component.
* @module @sbom-harbor-ui/dashboard/components/Footer
* @module sbom-harbor-ui/components/Footer
*/
import Box from '@mui/material/Box'
import Container from '@mui/material/Container'
Expand Down
2 changes: 1 addition & 1 deletion src/components/Header.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/components/Header
* @module sbom-harbor-ui/components/Header
*/
import Box from '@mui/material/Box'
import Toolbar from '@mui/material/Toolbar'
Expand Down
2 changes: 1 addition & 1 deletion src/components/HeaderAuthButton.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* A component used in the app header that renders either a login
* or logout button depending on the user's authentication status.
* @module @sbom-harbor-ui/dashboard/components/HeaderAuthButton
* @module sbom-harbor-ui/components/HeaderAuthButton
* @exports HeaderAuthButton
*/
import { Link as RouterLink } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/components/Image.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* An image component that defaults to lazy loading.
* @module @sbom-harbor-ui/dashboard/components/Image
* @module sbom-harbor-ui/components/Image
*/
import Box from '@mui/material/Box'

Expand Down
2 changes: 1 addition & 1 deletion src/components/SbomUploadInput.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/SbomUploadInput
* @module sbom-harbor-ui/hooks/SbomUploadInput
*/
import * as React from 'react'
import { useLoaderData } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/components/SearchInputField.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/SearchInputField
* @module sbom-harbor-ui/hooks/SearchInputField
*/
import * as React from 'react'
import FormControl from '@mui/material/FormControl'
Expand Down
2 changes: 1 addition & 1 deletion src/components/SimpleLoadingFallback.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/SimpleLoadingFallback
* @module sbom-harbor-ui/hooks/SimpleLoadingFallback
*/
import Container from '@mui/material/Container'

Expand Down
2 changes: 1 addition & 1 deletion src/components/SocialLoginButtons.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* A component that renders a horizontal list of social login buttons.
* @module @sbom-harbor-ui/dashboard/components/SocialLoginButtons
* @module sbom-harbor-ui/components/SocialLoginButtons
* @see {@link @sbom-harbor-ui/dashboard/components/Header} for usage.
*/
import { Link } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/components/UserAutocomplete.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Component that renders a text input with autocomplete
* for searching for users by their email address.
* @module @sbom-harbor-ui/dashboard/components/UserAutocomplete
* @module sbom-harbor-ui/components/UserAutocomplete
*/
import * as React from 'react'
import {
Expand Down
2 changes: 1 addition & 1 deletion src/components/UserAvatar.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* A component that renders a user's avatar image or initials.
* @module @sbom-harbor-ui/dashboard/components/UserAvatar
* @module sbom-harbor-ui/components/UserAvatar
*/
import { styled } from '@mui/material/styles'
import Avatar from '@/components/mui/Avatar'
Expand Down
2 changes: 1 addition & 1 deletion src/components/forms/SubmitButton.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* A component that renders a button to submit a form.
* @module @sbom-harbor-ui/dashboard/components/forms/SubmitButton
* @module sbom-harbor-ui/components/forms/SubmitButton
*/
import Button, { ButtonProps } from '@mui/material/Button'

Expand Down
2 changes: 1 addition & 1 deletion src/components/mui/Avatar.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* A component that renders a circular avatar for a user.
* @module @sbom-harbor-ui/dashboard/components/mui/avatar
* @module sbom-harbor-ui/components/mui/avatar
*/
import * as React from 'react'
import MuiAvatar, { AvatarProps } from '@mui/material/Avatar'
Expand Down
2 changes: 1 addition & 1 deletion src/components/mui/CardContent.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Custom MuiCardContent components
* @module @sbom-harbor-ui/dashboard/components/mui/CardContent
* @module sbom-harbor-ui/components/mui/CardContent
*/
import { styled } from '@mui/system'
import CardContent from '@mui/material/CardContent'
Expand Down
2 changes: 1 addition & 1 deletion src/components/mui/Chip.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Custom implementation of MuiChip.
* @module @sbom-harbor-ui/dashboard/components/mui/chip
* @module sbom-harbor-ui/components/mui/chip
*/
import MuiChip, { ChipProps } from '@mui/material/Chip'
import useBgColor, { UseBgColorType } from '@/hooks/useBgColor'
Expand Down
2 changes: 1 addition & 1 deletion src/components/mui/LinearLoadingBar.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Custom implementation of LinearProgress bar from MUI.
* @module @sbom-harbor-ui/dashboard/components/mui/LinerLoadingBar
* @module sbom-harbor-ui/components/mui/LinerLoadingBar
*/
import Box from '@mui/material/Box'
import LinearProgress from '@mui/material/LinearProgress'
Expand Down
2 changes: 1 addition & 1 deletion src/components/react-router/NavigateToLogin.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Component that renders the react-router Navigate component to
* redirect the user to the login page at the `/login` route.
* @module @sbom-harbor-ui/dashboard/components/react-router/NavigateToLogin
* @module sbom-harbor-ui/components/react-router/NavigateToLogin
*
* @see {@link @sbom-harbor-ui/dashboard/Routes} for usage.
* @see {@link https://reactrouter.com/web/api/Navigate} for documentation.
Expand Down
2 changes: 1 addition & 1 deletion src/constants.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/constants
* @module sbom-harbor-ui/constants
*/

//* Application Strings
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/types.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Types used in custom hooks.
* @module @sbom-harbor-ui/dashboard/hooks/types
* @module sbom-harbor-ui/hooks/types
*/

/**
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useAlert.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/useAlert
* @module sbom-harbor-ui/hooks/useAlert
*/
import * as React from 'react'
import { AlertColor } from '@mui/material/Alert'
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useAuth.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Custom React Hook to use the AuthContext in a functional component
* in order to access the AuthContext's state and dispatch functions.
* @module @sbom-harbor-ui/dashboard/hooks/useAuth
* @module sbom-harbor-ui/hooks/useAuth
* @exports AuthContext
* @exports AuthProvider
* @exports useAuth
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useBgColor.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Custom React Hook to get the background color of the current theme.
* @module @sbom-harbor-ui/dashboard/hooks/useBgColor
* @module sbom-harbor-ui/hooks/useBgColor
*/
import { useTheme } from '@mui/material/styles'
import { hexToRGBA } from '@/utils/hexToRGBA'
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useCopyToClipboard.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/useCopyToClipboard
* @module sbom-harbor-ui/hooks/useCopyToClipboard
*/
import * as React from 'react'

Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useData.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/useData
* @module sbom-harbor-ui/hooks/useData
*/
import * as React from 'react'
import { useAuthState } from '@/hooks/useAuth'
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useDialog.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/useDialog
* @module sbom-harbor-ui/hooks/useDialog
*/
import * as React from 'react'
import Dialog, { DialogProps } from '@mui/material/Dialog'
Expand Down
2 changes: 1 addition & 1 deletion src/hooks/useFetch.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/hooks/useFetch
* @module sbom-harbor-ui/hooks/useFetch
*/
import * as React from 'react'

Expand Down
2 changes: 1 addition & 1 deletion src/layouts/AppLayout/AppDrawerListItems.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/views/App/AppDrawerListItems
* @module sbom-harbor-ui/views/App/AppDrawerListItems
*/
import * as React from 'react'
import DashboardIcon from '@mui/icons-material/Dashboard'
Expand Down
2 changes: 1 addition & 1 deletion src/layouts/AppLayout/AppLayout.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* The layout for rendering the authenticated user's layout.
* @module @sbom-harbor-ui/dashboard/layouts/AppLayout/AppLayout
* @module sbom-harbor-ui/layouts/AppLayout/AppLayout
*/
// ** React Imports
import * as React from 'react'
Expand Down
2 changes: 1 addition & 1 deletion src/layouts/BlankLayout.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/layouts/BlankLayout
* @module sbom-harbor-ui/layouts/BlankLayout
*/
import * as React from 'react'
import { styled } from '@mui/material/styles'
Expand Down
2 changes: 1 addition & 1 deletion src/main.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* The entry point for the cyclonedx-ui-sbom frontend.
* @module @sbom-harbor-ui/dashboard
* @module sbom-harbor-ui
*/
import * as React from 'react'
import * as ReactDOMClient from 'react-dom/client'
Expand Down
2 changes: 1 addition & 1 deletion src/router/authLoader.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Auth state loader for react-router data routes.
* @module @sbom-harbor-ui/dashboard/loaders/authLoader
* @module sbom-harbor-ui/loaders/authLoader
* @see {@link @sbom-harbor-ui/dashboard/Routes}
*/
import { defer } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/router/router.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Component that renders all routes in the application.
* @module @sbom-harbor-ui/dashboard/router
* @module sbom-harbor-ui/router
* @see {@link @sbom-harbor-ui/dashboard/main} for usage.
*/
import { createHashRouter } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/router/teamLoader.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* State loader for react-router data routes that require a user's single team.
* @module @sbom-harbor-ui/dashboard/loaders/teamLoader
* @module sbom-harbor-ui/loaders/teamLoader
* @see {@link @sbom-harbor-ui/dashboard/Routes}
*/
import { defer, Params } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/router/teamsLoader.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* State loader for react-router data routes that require user's all teams.
* @module @sbom-harbor-ui/dashboard/loaders/teamsLoader
* @module sbom-harbor-ui/loaders/teamsLoader
* @see {@link @sbom-harbor-ui/dashboard/Routes}
*/
import { defer } from 'react-router-dom'
Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module @sbom-harbor-ui/dashboard/types
* @module sbom-harbor-ui/types
*/
import type {
CognitoIdToken,
Expand Down
Loading

0 comments on commit fd257d3

Please sign in to comment.