Added link explaining the layering PDP requirements in TSDocs

paranext · Jun 18, 2024 · 9f3bfa5 · 9f3bfa5
1 parent 35c7df5
commit 9f3bfa5
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 6 deletions.
diff --git a/lib/papi-dts/papi.d.ts b/lib/papi-dts/papi.d.ts
@@ -3817,7 +3817,9 @@ declare module 'shared/models/project-data-provider-engine-factory.model' {
    * {@link IBaseProjectDataProvider} and {@link ProjectDataProviderInterfaces} for more information.
    *
    * WARNING: For Layering PDPFs, `getAvailableProjects` has very specific requirements that
-   * **absolutely must** be met.
+   * **absolutely must** be met. Please see
+   * {@link IProjectDataProviderEngineFactory.getAvailableProjects} for more information on the
+   * requirements.
    *
    * To make creating a Layering PDPF easier, you can extend
    * {@link LayeringProjectDataProviderEngineFactory}, which automatically fulfills the special
@@ -3874,7 +3876,9 @@ declare module 'shared/models/project-data-provider-engine-factory.model' {
    * easier.
    *
    * Extending this class automatically fulfills the special requirements for Layering PDPfs, so we
-   * highly recommend extending this class.
+   * highly recommend extending this class. Please see
+   * {@link IProjectDataProviderEngineFactory.getAvailableProjects} for more information on the
+   * requirements.
    */
   export abstract class LayeringProjectDataProviderEngineFactory<
     SupportedProjectInterfaces extends ProjectInterfaces[],
@@ -5489,7 +5493,9 @@ declare module '@papi/backend' {
      * easier.
      *
      * Extending this class automatically fulfills the special requirements for Layering PDPfs, so we
-     * highly recommend extending this class.
+     * highly recommend extending this class. Please see
+     * {@link IProjectDataProviderEngineFactory.getAvailableProjects} for more information on the
+     * requirements.
      */
     LayeringProjectDataProviderEngineFactory: typeof PapiLayeringProjectDataProviderEngineFactory;
     /** This is just an alias for internet.fetch */
@@ -5629,7 +5635,9 @@ declare module '@papi/backend' {
    * easier.
    *
    * Extending this class automatically fulfills the special requirements for Layering PDPfs, so we
-   * highly recommend extending this class.
+   * highly recommend extending this class. Please see
+   * {@link IProjectDataProviderEngineFactory.getAvailableProjects} for more information on the
+   * requirements.
    */
   export const LayeringProjectDataProviderEngineFactory: typeof PapiLayeringProjectDataProviderEngineFactory;
   /** This is just an alias for internet.fetch */

diff --git a/src/shared/models/project-data-provider-engine-factory.model.ts b/src/shared/models/project-data-provider-engine-factory.model.ts
@@ -25,7 +25,9 @@ import { escapeStringRegexp } from 'platform-bible-utils';
  * {@link IBaseProjectDataProvider} and {@link ProjectDataProviderInterfaces} for more information.
  *
  * WARNING: For Layering PDPFs, `getAvailableProjects` has very specific requirements that
- * **absolutely must** be met.
+ * **absolutely must** be met. Please see
+ * {@link IProjectDataProviderEngineFactory.getAvailableProjects} for more information on the
+ * requirements.
  *
  * To make creating a Layering PDPF easier, you can extend
  * {@link LayeringProjectDataProviderEngineFactory}, which automatically fulfills the special
@@ -60,7 +62,9 @@ export interface IProjectDataProviderEngineFactory<
  * easier.
  *
  * Extending this class automatically fulfills the special requirements for Layering PDPfs, so we
- * highly recommend extending this class.
+ * highly recommend extending this class. Please see
+ * {@link IProjectDataProviderEngineFactory.getAvailableProjects} for more information on the
+ * requirements.
  */
 export abstract class LayeringProjectDataProviderEngineFactory<
   SupportedProjectInterfaces extends ProjectInterfaces[],