From 460bfbf6e556aa41cc9dd1d473c5ecb41b4961fe Mon Sep 17 00:00:00 2001 From: evlist Date: Mon, 17 Oct 2022 21:31:21 +0200 Subject: [PATCH] Doc --- src/components/map/Tile.tsx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/components/map/Tile.tsx b/src/components/map/Tile.tsx index 757c0a1..bd568f7 100644 --- a/src/components/map/Tile.tsx +++ b/src/components/map/Tile.tsx @@ -1,11 +1,11 @@ import react, { useEffect, useRef } from 'react'; export interface TileProperties { - // The image's source URL + /** The image's source URL */ href: string; - // Its size + /** Its size */ size: number; - // A delay to add (for test/debug purposes) + /** A delay to add (for test/debug purposes) */ delay?: number; } @@ -13,6 +13,10 @@ export interface TileProperties { * * @param props * @returns A tile + * + * Tile components are containers for images. + * They return an empty element immediately so that the rendering can proceed + * and append a, element whenever the image is loaded. */ export const Tile: react.FC = (props: TileProperties) => { const g = useRef(null);