Minor docs improvements (#1339)

Author: Rel1cx

packages/core/docs/functions/isReactAPI.md

@@ -6,12 +6,16 @@
 function isReactAPI(api: string): ReturnType;
 ```
 
+Checks if the node is a React API identifier or member expression
+
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `api` | `string` |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `api` | `string` | The React API name to check against (e.g., "useState", "React.memo") |
 
 ## Returns
 
 [`ReturnType`](../@eslint-react/namespaces/isReactAPI/type-aliases/ReturnType.md)
+
+A predicate function to check if a node matches the API

packages/core/docs/functions/isReactAPICall.md

@@ -6,12 +6,16 @@
 function isReactAPICall(api: string): ReturnType;
 ```
 
+Checks if the node is a call expression to a specific React API
+
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `api` | `string` |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `api` | `string` | The React API name to check against |
 
 ## Returns
 
 [`ReturnType`](../@eslint-react/namespaces/isReactAPICall/type-aliases/ReturnType.md)
+
+A predicate function to check if a node is a call to the API

packages/core/src/component/component-collector-legacy.ts

@@ -70,7 +70,8 @@ export function useComponentCollectorLegacy(): useComponentCollectorLegacy.Retur
 
 /**
  * Check whether the given node is a this.setState() call
- * @param node - The node to check
+ * @param node The node to check
+ * @param node
  * @internal
  */
 export function isThisSetState(node: TSESTree.CallExpression) {
@@ -85,7 +86,8 @@ export function isThisSetState(node: TSESTree.CallExpression) {
 
 /**
  * Check whether the given node is an assignment to this.state
- * @param node - The node to check
+ * @param node The node to check
+ * @param node
  * @internal
  */
 export function isAssignmentToThisState(node: TSESTree.AssignmentExpression) {

packages/core/src/component/component-definition.ts

@@ -35,7 +35,8 @@ const FUNCTION_PATTERNS = {
 /**
  * Checks if the given node is a function within a render method of a class component.
  *
- * @param node - The AST node to check
+ * @param node The AST node to check
+ * @param node
  * @returns `true` if the node is a render function inside a class component
  *
  * @example
@@ -60,8 +61,10 @@ function isFunctionOfRenderMethod(node: AST.TSESTreeFunction) {
 /**
  * Checks if a function node should be excluded based on provided detection hints
  *
- * @param node - The function node to check
- * @param hint - Component detection hints as bit flags
+ * @param node The function node to check
+ * @param hint Component detection hints as bit flags
+ * @param node
+ * @param hint
  * @returns `true` if the function matches an exclusion hint
  */
 function shouldExcludeBasedOnHint(node: AST.TSESTreeFunction, hint: bigint): boolean {
@@ -87,8 +90,10 @@ function shouldExcludeBasedOnHint(node: AST.TSESTreeFunction, hint: bigint): boo
 /**
  * Determines if the node is an argument within `createElement`'s children list (3rd argument onwards)
  *
- * @param context - The rule context
- * @param node - The AST node to check
+ * @param context The rule context
+ * @param node The AST node to check
+ * @param context
+ * @param node
  * @returns `true` if the node is passed as a child to `createElement`
  */
 function isChildrenOfCreateElement(context: RuleContext, node: TSESTree.Node): boolean {
@@ -111,9 +116,12 @@ function isChildrenOfCreateElement(context: RuleContext, node: TSESTree.Node): b
 /**
  * Determines if a function node represents a valid React component definition
  *
- * @param context - The rule context
- * @param node - The function node to analyze
- * @param hint - Component detection hints (bit flags) to customize detection logic
+ * @param context The rule context
+ * @param node The function node to analyze
+ * @param hint Component detection hints (bit flags) to customize detection logic
+ * @param context
+ * @param node
+ * @param hint
  * @returns `true` if the node is considered a component definition
  */
 export function isComponentDefinition(

packages/core/src/component/component-name.ts

@@ -7,23 +7,23 @@ import { getFunctionComponentId } from "./component-id";
 
 /**
  * Check if a string matches the strict component name pattern
- * @param name - The name to check
+ * @param name The name to check
  */
 export function isComponentName(name: string) {
   return RE_COMPONENT_NAME.test(name);
 }
 
 /**
  * Check if a string matches the loose component name pattern
- * @param name - The name to check
+ * @param name The name to check
  */
 export function isComponentNameLoose(name: string) {
   return RE_COMPONENT_NAME_LOOSE.test(name);
 }
 
 /**
  * Get component name from an identifier or identifier sequence (e.g., MemberExpression)
- * @param id - The identifier or identifier sequence
+ * @param id The identifier or identifier sequence
  */
 export function getComponentNameFromId(id: TSESTree.Identifier | TSESTree.Identifier[] | unit) {
   if (id == null) return unit;
@@ -34,8 +34,8 @@ export function getComponentNameFromId(id: TSESTree.Identifier | TSESTree.Identi
 
 /**
  * Check if the function has no name or a loose component name
- * @param context - The rule context
- * @param fn - The function node
+ * @param context The rule context
+ * @param fn The function node
  */
 export function hasNoneOrLooseComponentName(context: RuleContext, fn: AST.TSESTreeFunction) {
   const id = getFunctionComponentId(context, fn);

packages/core/src/jsx/jsx-element-is.ts

@@ -7,8 +7,8 @@ import { getJsxElementType } from "./jsx-element-type";
  * Determines if a JSX element is a host element
  * Host elements in React start with lowercase letters (e.g., div, span)
  *
- * @param context - ESLint rule context
- * @param node - AST node to check
+ * @param context ESLint rule context
+ * @param node AST node to check
  * @returns boolean indicating if the element is a host element
  */
 export function isJsxHostElement(context: RuleContext, node: TSESTree.Node) {
@@ -21,8 +21,8 @@ export function isJsxHostElement(context: RuleContext, node: TSESTree.Node) {
  * Determines if a JSX element is a React Fragment
  * Fragments can be imported from React and used like <Fragment> or <React.Fragment>
  *
- * @param context - ESLint rule context
- * @param node - AST node to check
+ * @param context ESLint rule context
+ * @param node AST node to check
  * @returns boolean indicating if the element is a Fragment with type narrowing
  */
 export function isJsxFragmentElement(context: RuleContext, node: TSESTree.Node): node is TSESTree.JSXElement {

packages/core/src/jsx/jsx-element-type.ts

@@ -8,8 +8,8 @@ import { stringifyJsx } from "./jsx-stringify";
  * For JSX elements, returns the stringified name (e.g., "div", "Button", "React.Fragment")
  * For JSX fragments, returns an empty string
  *
- * @param context - ESLint rule context
- * @param node - JSX element or fragment node
+ * @param context ESLint rule context
+ * @param node JSX element or fragment node
  * @returns String representation of the element type
  */
 export function getJsxElementType(context: RuleContext, node: TSESTree.JSXElement | TSESTree.JSXFragment) {

packages/core/src/jsx/jsx-hierarchy.ts

@@ -7,8 +7,8 @@ import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
 /**
  * Traverses up the AST to find a parent JSX attribute node that matches a given test
  *
- * @param node - The starting AST node
- * @param test - Optional predicate function to test if the attribute meets criteria
+ * @param node The starting AST node
+ * @param test Optional predicate function to test if the attribute meets criteria
  *               Defaults to always returning true (matches any attribute)
  * @returns The first matching JSX attribute node found when traversing upwards, or undefined
  */

packages/core/src/jsx/jsx-stringify.ts

@@ -4,7 +4,7 @@ import type { TSESTree } from "@typescript-eslint/utils";
 /**
  * Incomplete but sufficient stringification of JSX nodes for common use cases
  *
- * @param node - JSX node from TypeScript ESTree
+ * @param node JSX node from TypeScript ESTree
  * @returns String representation of the JSX node
  */
 export function stringifyJsx(

packages/core/src/utils/is-react-api.ts

@@ -13,6 +13,11 @@ export declare namespace isReactAPI {
   };
 }
 
+/**
+ * Checks if the node is a React API identifier or member expression
+ * @param api The React API name to check against (e.g., "useState", "React.memo")
+ * @returns A predicate function to check if a node matches the API
+ */
 export function isReactAPI(api: string): isReactAPI.ReturnType {
   const func = (context: RuleContext, node: unit | null | TSESTree.Node): node is
     | TSESTree.Identifier
@@ -35,6 +40,11 @@ export declare namespace isReactAPICall {
   };
 }
 
+/**
+ * Checks if the node is a call expression to a specific React API
+ * @param api The React API name to check against
+ * @returns A predicate function to check if a node is a call to the API
+ */
 export function isReactAPICall(api: string): isReactAPICall.ReturnType {
   const func = (context: RuleContext, node: unit | null | TSESTree.Node): node is TSESTree.CallExpression => {
     if (node == null) return false;
@@ -44,6 +54,7 @@ export function isReactAPICall(api: string): isReactAPICall.ReturnType {
   return dual(2, func);
 }
 
+// React API checks
 export const isCaptureOwnerStack = isReactAPI("captureOwnerStack");
 export const isChildrenCount = isReactAPI("Children.count");
 export const isChildrenForEach = isReactAPI("Children.forEach");
@@ -58,6 +69,7 @@ export const isForwardRef = isReactAPI("forwardRef");
 export const isMemo = isReactAPI("memo");
 export const isLazy = isReactAPI("lazy");
 
+// React API Call checks
 export const isCaptureOwnerStackCall = isReactAPICall("captureOwnerStack");
 export const isChildrenCountCall = isReactAPICall("Children.count");
 export const isChildrenForEachCall = isReactAPICall("Children.forEach");