Update doc comments

react18-tools · Apr 29, 2024 · 63aea8f · 63aea8f
1 parent 17853a4
commit 63aea8f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/lib/r18gs/src/plugins/persist-and-sync.ts b/lib/r18gs/src/plugins/persist-and-sync.ts
@@ -1,5 +1,10 @@
 import { Plugin } from "..";
 
+/**
+ * A plugin that persists and syncs RGS store between tabs.
+ *
+ * @returns A plugin that persists and syncs a value between tabs.
+ */
 function persistAndSyncPlugin<T>(): Plugin<T> {
 	return {
 		init(key, value, _, mutate) {

diff --git a/packages/shared-ui/src/root/persistant-counter.tsx b/packages/shared-ui/src/root/persistant-counter.tsx
@@ -3,6 +3,11 @@
 import { ChangeEvent, useCallback } from "react";
 import { useMyPersistantCounterStore } from "../../hooks/use-persistant-counter";
 
+/**
+ * Persistant Counter
+ *
+ * @returns {JSX.Element}
+ */
 export default function PersistantCounter() {
 	const [count, setCount] = useMyPersistantCounterStore();