fix js doc comments

Author: laurelthorburn

packages/hydrogen-react/src/CartLineProvider.tsx

@@ -12,7 +12,9 @@ type CartLinePartialDeep = PartialDeep<
 
 export const CartLineContext = createContext<CartLinePartialDeep | null>(null);
 
-/** @publicDocs */
+/**
+ * The `useCartLine` hook provides access to the [CartLine object](https://shopify.dev/api/storefront/2026-01/objects/cartline) from the Storefront API. It must be a descendent of a `CartProvider` component.
+ */
 export function useCartLine(): CartLinePartialDeep {
   const context = useContext(CartLineContext);
 

packages/hydrogen-react/src/MediaFile.tsx

@@ -9,10 +9,7 @@ import type {ModelViewerElement} from '@google/model-viewer/lib/model-viewer.js'
 type BaseProps = React.HTMLAttributes<
   HTMLImageElement | HTMLVideoElement | HTMLIFrameElement | ModelViewerElement
 >;
-/**
- * MediaFile renders an `Image`, `Video`, `ExternalVideo`, or `ModelViewer` component. Use the `mediaOptions` prop to customize the props sent to each of these components.
- * @publicDocs
- */
+/** @publicDocs */
 export interface MediaFileProps extends BaseProps {
   /** An object with fields that correspond to the Storefront API's [Media object](https://shopify.dev/api/storefront/reference/products/media). */
   data: PartialDeep<MediaEdgeType['node'], {recurseIntoArrays: true}>;
@@ -38,7 +35,6 @@ type MediaOptions = {
  * The `MediaFile` component renders the media for the Storefront API's
  * [Media object](https://shopify.dev/api/storefront/reference/products/media). It renders an `Image`, a
  * `Video`, an `ExternalVideo`, or a `ModelViewer` depending on the `__typename` of the `data` prop.
- * Use the `mediaOptions` prop to customize the props sent to each of these components.
  * @publicDocs
  */
 export function MediaFile({

packages/hydrogen-react/src/ShopPayButton.tsx

@@ -65,12 +65,7 @@ function isChannel(
   return channel === 'headless' || channel === 'hydrogen';
 }
 
-/**
- * The `ShopPayButton` component renders a button that redirects to the Shop Pay checkout.
- * It renders a [`<shop-pay-button>`](https://shopify.dev/custom-storefronts/tools/web-components) custom element, for which it will lazy-load the source code automatically.
- * It relies on the `<ShopProvider>` context provider.
- * @publicDocs
- */
+/** @publicDocs */
 export function ShopPayButton({
   channel,
   variantIds,

packages/hydrogen-react/src/analytics.ts

@@ -19,7 +19,14 @@ import {
 } from './analytics-schema-custom-storefront-customer-tracking.js';
 import {getTrackingValues} from './tracking-utils.js';
 
-/** @publicDocs */
+/**
+ * Set user and session cookies and refresh the expiry time
+ * @param event - The analytics event.
+ * @param shopDomain - The Online Store domain to sent Shopify analytics under the same
+ *   top level domain.
+ * @publicDocs
+ */
+
 export function sendShopifyAnalytics(
   event: ShopifyAnalytics,
   shopDomain?: string,

packages/hydrogen-react/src/cookies-utils.tsx

@@ -59,6 +59,7 @@ export function hexTime(): string {
 }
 
 /**
+ * Gets the values of _shopify_y and _shopify_s cookies from the provided cookie string.
  * @deprecated Use getTrackingValues instead.
  * @publicDocs
  */

packages/hydrogen-react/src/flatten-connection.ts

@@ -91,8 +91,5 @@ type ConnectionNodes = {
 export interface ConnectionGenericForDoc {
   connection?: ConnectionEdges | ConnectionNodes;
 }
-/**
- * The return type of the `flattenConnection` utility: a flat array of nodes extracted from a Storefront API connection object.
- * @publicDocs
- */
+/** @publicDocs */
 export type FlattenConnectionReturnForDoc = unknown[];

packages/hydrogen-react/src/optionValueDecoder.ts

@@ -20,10 +20,7 @@ const V1_CONTROL_CHARS = {
   RANGE: '-',
 };
 
-/**
- * A function type that determines whether a given option value combination is present in an encoded variant field from the Storefront API.
- * @publicDocs
- */
+/** @publicDocs */
 export type IsOptionValueCombinationInEncodedVariant = (
   targetOptionValueCombination: number[],
   encodedVariantField: string,

packages/hydrogen-react/src/parse-metafield.ts

@@ -13,7 +13,16 @@ import type {PartialDeep, Simplify} from 'type-fest';
 import {flattenConnection} from './flatten-connection.js';
 import {RootASTNode as RichTextRootASTNode} from './RichText.types.js';
 
-/** @publicDocs */
+/**
+ * A function that uses `metafield.type` to parse the Metafield's `value` or `reference` or `references` (depending on the `metafield.type`) and places the result in `metafield.parsedValue`
+ *
+ * TypeScript developers can use the type `ParsedMetafields` from this package to get the returned object's type correct. For example:
+ *
+ * ```
+ * parseMetafield<ParsedMetafields['boolean']>({type: 'boolean', value: 'false'}
+ * ```
+ * @publicDocs
+ */
 export function parseMetafield<ReturnGeneric>(
   metafield: PartialDeep<MetafieldBaseType, {recurseIntoArrays: true}>,
 ): ReturnGeneric {