✏️ Added jsDoc for some components
This commit is contained in:
@@ -8,9 +8,6 @@ import LibraryGrid from "./Library/LibraryGrid";
|
|||||||
import Search from "./Search";
|
import Search from "./Search";
|
||||||
import Settings from "./Settings";
|
import Settings from "./Settings";
|
||||||
import VolumeDetail from "./VolumeDetail/VolumeDetail";
|
import VolumeDetail from "./VolumeDetail/VolumeDetail";
|
||||||
import PullList from "./PullList/PullList";
|
|
||||||
import WantedComics from "./WantedComics/WantedComics";
|
|
||||||
import Volumes from "./Volumes/Volumes";
|
|
||||||
import Downloads from "./Downloads/Downloads";
|
import Downloads from "./Downloads/Downloads";
|
||||||
|
|
||||||
import { Routes, Route } from "react-router-dom";
|
import { Routes, Route } from "react-router-dom";
|
||||||
@@ -23,9 +20,6 @@ import {
|
|||||||
import { isEmpty, isUndefined } from "lodash";
|
import { isEmpty, isUndefined } from "lodash";
|
||||||
import { AIRDCPP_DOWNLOAD_PROGRESS_TICK } from "../constants/action-types";
|
import { AIRDCPP_DOWNLOAD_PROGRESS_TICK } from "../constants/action-types";
|
||||||
import { useDispatch } from "react-redux";
|
import { useDispatch } from "react-redux";
|
||||||
import axios from "axios";
|
|
||||||
import { LIBRARY_SERVICE_BASE_URI } from "../constants/endpoints";
|
|
||||||
import { useParams } from "react-router";
|
|
||||||
|
|
||||||
const AirDCPPSocketComponent = (): ReactElement => {
|
const AirDCPPSocketComponent = (): ReactElement => {
|
||||||
const airDCPPConfiguration = useContext(AirDCPPSocketContext);
|
const airDCPPConfiguration = useContext(AirDCPPSocketContext);
|
||||||
|
|||||||
@@ -8,6 +8,14 @@ import { useDispatch, useSelector } from "react-redux";
|
|||||||
import { searchIssue } from "../../actions/fileops.actions";
|
import { searchIssue } from "../../actions/fileops.actions";
|
||||||
import ellipsize from "ellipsize";
|
import ellipsize from "ellipsize";
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Component that tabulates the contents of the user's ThreeTwo Library.
|
||||||
|
*
|
||||||
|
* @component
|
||||||
|
* @example
|
||||||
|
* <Library />
|
||||||
|
*/
|
||||||
export const Library = (): ReactElement => {
|
export const Library = (): ReactElement => {
|
||||||
const searchResults = useSelector(
|
const searchResults = useSelector(
|
||||||
(state: RootState) => state.fileOps.libraryComics,
|
(state: RootState) => state.fileOps.libraryComics,
|
||||||
@@ -141,7 +149,7 @@ export const Library = (): ReactElement => {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Pagination control that fetches the next x (pageSize) items
|
* Pagination control that fetches the next x (pageSize) items
|
||||||
* based on the y (pageIndex) offset from the Elasticsearch index
|
* based on the y (pageIndex) offset from the ThreeTwo Elasticsearch index
|
||||||
* @param {number} pageIndex
|
* @param {number} pageIndex
|
||||||
* @param {number} pageSize
|
* @param {number} pageSize
|
||||||
* @returns void
|
* @returns void
|
||||||
@@ -168,7 +176,7 @@ export const Library = (): ReactElement => {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Pagination control that fetches the previous x (pageSize) items
|
* Pagination control that fetches the previous x (pageSize) items
|
||||||
* based on the y (pageIndex) offset from the Elasticsearch index
|
* based on the y (pageIndex) offset from the ThreeTwo Elasticsearch index
|
||||||
* @param {number} pageIndex
|
* @param {number} pageIndex
|
||||||
* @param {number} pageSize
|
* @param {number} pageSize
|
||||||
* @returns void
|
* @returns void
|
||||||
|
|||||||
@@ -7,6 +7,15 @@ import { Library } from "./Library";
|
|||||||
interface ITabulatedContentContainerProps {
|
interface ITabulatedContentContainerProps {
|
||||||
category: string;
|
category: string;
|
||||||
}
|
}
|
||||||
|
/**
|
||||||
|
* Component to draw the contents of a category in a table.
|
||||||
|
*
|
||||||
|
* @component
|
||||||
|
* @example
|
||||||
|
* return (
|
||||||
|
* <TabulatedContentContainer category={"library"} />
|
||||||
|
* )
|
||||||
|
*/
|
||||||
|
|
||||||
const TabulatedContentContainer = (
|
const TabulatedContentContainer = (
|
||||||
props: ITabulatedContentContainerProps,
|
props: ITabulatedContentContainerProps,
|
||||||
|
|||||||
Reference in New Issue
Block a user