From 36c74bd8a2a04bcfdf487668910eac386ae2e4eb Mon Sep 17 00:00:00 2001
From: Dan Percic <dan@devplant.ro>
Date: Thu, 22 Dec 2022 16:26:03 +0200
Subject: [PATCH] update listing providers factory description

---
 src/lib/listing/utils.ts | 38 +++++++++++++++++++++++++++++++++++---
 1 file changed, 35 insertions(+), 3 deletions(-)

diff --git a/src/lib/listing/utils.ts b/src/lib/listing/utils.ts
index f997f36..ffce109 100644
--- a/src/lib/listing/utils.ts
+++ b/src/lib/listing/utils.ts
@@ -48,17 +48,49 @@ function getComponent(component: Type<unknown>) {
 
 /**
  * This is equivalent to
- * @example <code>[FilterService, SearchService, SortingService, ListingService, EntitiesService]</code>
+ * @example
+ * [
+ *   FilterService,
+ *   SearchService,
+ *   SortingService,
+ *   ListingService,
+ *   EntitiesService
+ * ]
  */
 export function listingProvidersFactory(): Provider[];
 /**
  * This is equivalent to
- * @example <code>[{provide: ListingComponent, useExisting: forwardRef(() => component)}, EntitiesService, FilterService, SearchService, SortingService, ListingService]</code>
+ * @example
+ * [
+ *   {
+ *     provide: ListingComponent,
+ *     useExisting: forwardRef(() => component)
+ *   },
+ *   EntitiesService,
+ *   FilterService,
+ *   SearchService,
+ *   SortingService,
+ *   ListingService
+ * ]
  */
 export function listingProvidersFactory(component: Type<unknown>): Provider[];
 /**
  * This is equivalent to
- * @example <code>[{provide: EntitiesService, useExisting: entitiesService}, {provide: ListingComponent, useExisting: forwardRef(() => component)}, FilterService, SearchService, SortingService, ListingService]</code>
+ * @example
+ * [
+ *   {
+ *     provide: EntitiesService,
+ *     useExisting: entitiesService
+ *   },
+ *   {
+ *     provide: ListingComponent,
+ *     useExisting: forwardRef(() => component)
+ *   },
+ *   FilterService,
+ *   SearchService,
+ *   SortingService,
+ *   ListingService
+ * ]
  */
 export function listingProvidersFactory<T extends IListable<PrimaryKey>, PrimaryKey extends Id = T['id']>(
     options: IListingServiceFactoryOptions<T>,