resolve comments

https://coveord.atlassian.net/browse/KIT-3392
coveo · Aug 19, 2024 · bf875c2 · bf875c2
1 parent 31f1ac1
commit bf875c2
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 1 deletion.
diff --git a/...eadless/src/controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.ts b/...eadless/src/controllers/commerce/core/pagination/headless-core-commerce-pagination.ssr.ts
@@ -14,6 +14,14 @@ import {
 
 export type {Pagination, PaginationProps, PaginationState};
 
+/**
+ * Defines a `Pagination` controller instance.
+ *
+ * @param props - The configurable `Pagination` properties.
+ * @returns The `Pagination` controller definition.
+ *
+ * @internal
+ */
 export function definePagination<
   TOptions extends ControllerDefinitionOption | undefined,
 >(props?: PaginationProps, options?: TOptions) {

diff --git a/...ss/src/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.ts b/...ss/src/controllers/commerce/core/parameter-manager/headless-core-parameter-manager.ssr.ts
@@ -33,6 +33,13 @@ export type {
   CommerceSearchParameters,
 };
 
+/**
+ * Defines a `ParameterManager` controller instance.
+ *
+ * @returns The `ParameterManager` controller definition.
+ *
+ * @internal
+ */
 export function defineParameterManager<
   TOptions extends ControllerDefinitionOption | undefined,
 >(options?: TOptions) {

diff --git a/packages/headless/src/controllers/commerce/core/sort/headless-core-commerce-sort.ssr.ts b/packages/headless/src/controllers/commerce/core/sort/headless-core-commerce-sort.ssr.ts
@@ -10,6 +10,14 @@ import {Sort, SortProps, SortState} from './headless-core-commerce-sort';
 
 export type {Sort, SortProps, SortState};
 
+/**
+ * Defines a `Sort` controller instance.
+ *
+ * @param props - The configurable `Sort` properties.
+ * @returns The `Sort` controller definition.
+ *
+ * @internal
+ */
 export function defineSort<
   TOptions extends ControllerDefinitionOption | undefined,
 >(props?: SortProps, options?: TOptions) {

diff --git a/packages/headless/src/controllers/commerce/core/summary/headless-core-summary.ssr.ts b/packages/headless/src/controllers/commerce/core/summary/headless-core-summary.ssr.ts
@@ -19,6 +19,13 @@ export type {
   SummaryState,
 };
 
+/**
+ * Defines a `Summary` controller instance.
+ *
+ * @returns The `Summary` controller definition.
+ *
+ * @internal
+ */
 export function defineSummary<
   TOptions extends ControllerDefinitionOption | undefined,
 >(options?: TOptions) {

diff --git a/packages/headless/src/controllers/commerce/product-view/headless-product-view.ssr.ts b/packages/headless/src/controllers/commerce/product-view/headless-product-view.ssr.ts
@@ -13,7 +13,11 @@ export interface ProductViewDefinition
   extends SharedControllerDefinitionWithoutProps<ProductView> {}
 
 /**
- * Defines a `ProductView` controller.
+ * Defines a `ProductView` controller instance.
+ *
+ * This controller is stateless and does not implement a `subscribe` method,
+ * making it simpler but different from other controllers in the system.
+ * Its sole purpose is to log an `ec_productView` event.
  *
  * @returns The `ProductView` controller definition.
  *

diff --git a/packages/headless/src/controllers/commerce/search/did-you-mean/headless-did-you-mean.ssr.ts b/packages/headless/src/controllers/commerce/search/did-you-mean/headless-did-you-mean.ssr.ts
@@ -4,6 +4,13 @@ import {DidYouMean, DidYouMeanState} from './headless-did-you-mean';
 
 export type {DidYouMean, DidYouMeanState};
 
+/**
+ * Defines a `DidYouMean` controller instance.
+ *
+ * @returns The `DidYouMean` controller definition.
+ *
+ * @internal
+ * */
 export function defineDidYouMean(): SearchOnlyControllerDefinitionWithoutProps<DidYouMean> {
   return {
     search: true,