fix docs generation

Author: brophdawg11

docs/start/framework/route-module.md

@@ -164,6 +164,7 @@ export const clientMiddleware = [loggingMiddleware];
 See also:
 
 - [Middleware][middleware]
+- [Client Data][client-data]
 
 ## `loader`
 
@@ -217,6 +218,7 @@ That way, React Router can derive types for `loaderData` based on the value of `
 See also:
 
 - [`clientLoader` params][client-loader-params]
+- [Client Data][client-data]
 
 ## `action`
 
@@ -275,6 +277,7 @@ export async function clientAction({ serverAction }) {
 See also:
 
 - [`clientAction` params][client-action-params]
+- [Client Data][client-data]
 
 ## `ErrorBoundary`
 
@@ -519,3 +522,4 @@ Next: [Rendering Strategies](./rendering)
 [meta-function]: https://api.reactrouter.com/v7/types/react_router.MetaDescriptor.html
 [data-mode-should-revalidate]: ../data/route-object#shouldrevalidate
 [spa-mode]: ../../how-to/spa
+[client-data]: ../../how-to/client-data

packages/react-router/lib/hooks.tsx

@@ -233,12 +233,14 @@ function useIsomorphicLayoutEffect(
  *
  * * `to` can be a string path, a {@link To} object, or a number (delta)
  * * `options` contains options for modifying the navigation
- *   * `flushSync`: Wrap the DOM updates in [`ReactDom.flushSync`](https://react.dev/reference/react-dom/flushSync)
- *   * `preventScrollReset`: Do not scroll back to the top of the page after navigation
- *   * `relative`: `"route"` or `"path"` to control relative routing logic
- *   * `replace`: Replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History) stack
- *   * `state`: Optional [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state) to include with the new {@link Location}
- *   * `viewTransition`: Enable [`document.startViewTransition`](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for this navigation
+ *   * These options work in all modes (Framework, Data, and Declarative):
+ *     * `relative`: `"route"` or `"path"` to control relative routing logic
+ *     * `replace`: Replace the current entry in the [`History`](https://developer.mozilla.org/en-US/docs/Web/API/History) stack
+ *     * `state`: Optional [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state) to include with the new {@link Location}
+ *   * These options only work in Framework and Data modes:
+ *     * `flushSync`: Wrap the DOM updates in [`ReactDom.flushSync`](https://react.dev/reference/react-dom/flushSync)
+ *     * `preventScrollReset`: Do not scroll back to the top of the page after navigation
+ *     * `viewTransition`: Enable [`document.startViewTransition`](https://developer.mozilla.org/en-US/docs/Web/API/Document/startViewTransition) for this navigation
  *
  * @example
  * import { useNavigate } from "react-router";

packages/react-router/lib/router/utils.ts

@@ -1984,7 +1984,8 @@ export class ErrorResponseImpl implements ErrorResponse {
 /**
  * Check if the given error is an {@link ErrorResponse} generated from a 4xx/5xx
  * [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
- * thrown from an [`action`](../../start/framework/route-module#action)/[`loader`](../../start/framework/route-module#loader)
+ * thrown from an [`action`](../../start/framework/route-module#action) or
+ * [`loader`](../../start/framework/route-module#loader) function.
  *
  * @example
  * import { isRouteErrorResponse } from "react-router";
@@ -2010,7 +2011,6 @@ export class ErrorResponseImpl implements ErrorResponse {
  * @mode data
  * @param error The error to check.
  * @returns `true` if the error is an {@link ErrorResponse}, `false` otherwise.
- *
  */
 export function isRouteErrorResponse(error: any): error is ErrorResponse {
   return (
@@ -2022,6 +2022,12 @@ export function isRouteErrorResponse(error: any): error is ErrorResponse {
   );
 }
 
+/*
+lol - this comment is needed because the JSDoc parser for `docs.ts` gets confused
+by the star-slash in the `getRoutePattern` regex and messes up the parsed comment
+for `isRouteErrorResponse` above.  This comment seems to reset the parser.
+*/
+
 export function getRoutePattern(paths: (string | undefined)[]) {
   return paths.filter(Boolean).join("/").replace(/\/\/*/g, "/") || "/";
 }