yuvrajkarna2717/react-hook-granth
[Docs]: Add JSDoc documentation to all hooks
Ouverte
#5 ouverte le 6 déc. 2025
documentationenhancementhelp wanted
Métriques du dépôt
- Stars
- (3 étoiles)
- Métriques de merge PR
- (Métriques PR en attente)
Description
Description: Add comprehensive JSDoc comments to all existing hooks for better IntelliSense and developer experience.
Requirements:
- Add JSDoc comments to all hook functions
- Include parameter descriptions
- Include return value descriptions
- Add usage examples in comments
Example:
/**
* A hook that manages counter state with increment, decrement, and reset functionality.
*
* @param initialValue - The initial counter value (default: 0)
* @returns An object containing the current count and control functions
*
* @example
* ```tsx
* const { count, increment, decrement, reset } = useCounter(10);
* ```
*/
export default function useCounter(initialValue: number = 0) {
// implementation
}