Replace incorrect @typeParam JSDoc tags with @template tags #336
Description
Summary
Generic types and generic functions throughout the Fedify codebase have JSDoc comments that incorrectly use @typeParam tags to document type parameters. These need to be replaced with the correct @template tag.
Affected Docs
All TypeScript/JavaScript files in the Fedify codebase that contain JSDoc comments with @typeParam tags. This affects inline documentation for generic types and generic functions across the entire codebase.
What's Missing or Incorrect?
The JSDoc comments are using a non-existent @typeParam tag to document type parameters. The @typeParam tag does not exist in the JSDoc specification. The correct tag for documenting type parameters in JSDoc is @template.
Current incorrect usage:
/**
* @typeParam T The type parameter
*/Suggested Content or Structure
All instances of @typeParam should be replaced with @template:
/**
* @template T The type parameter
*/The replacement should maintain the same syntax and formatting, only changing the tag name from @typeParam to @template.
Related Code / Feature
This affects documentation generation and IDE support for generic types and functions throughout the codebase. While this is a documentation-only change that won't affect runtime behavior, it's important for:
- Proper documentation generation tools recognition
- IDE autocomplete and type hints
- Developer experience when working with the codebase