docs: tsdoc @example code snippet format (#62, #67)

Co-authored-by: Daniel Philip Johnson <[email protected]> Co-authored-by: Daniel Philip Johnson <[email protected]> Co-authored-by: lihbr <[email protected]>
prismicio · Jul 6, 2023 · eeaddc4 · eeaddc4
1 parent 7dd808f
commit eeaddc4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 11 deletions.
diff --git a/src/components/SliceZone.ts b/src/components/SliceZone.ts
@@ -156,19 +156,21 @@ export type DefineComponentSliceComponentProps<
  *
  * Props are: `["slice", "index", "slices", "context"]`
  *
- * @example Defining a new slice component:
+ * @example
  *
  * ```javascript
+ * // Defining a new slice component
  * import { getSliceComponentProps } from "@prismicio/vue";
  *
  * export default {
  * 	props: getSliceComponentProps(),
  * };
  * ```
  *
- * @example Defining a new slice component with visual hint:
+ * @example
  *
  * ```javascript
+ * // Defining a new slice component with visual hint
  * import { getSliceComponentProps } from "@prismicio/vue";
  *
  * export default {
@@ -302,9 +304,10 @@ export type SliceZoneComponents<
  * @remarks
  * This is essentially an helper function to ensure {@link markRaw} is correctly
  * applied on each components, improving performances.
- * @example Defining a slice components:
+ * @example
  *
  * ```javascript
+ * // Defining a slice components
  * import { defineSliceZoneComponents } from "@prismicio/vue";
  *
  * export default {

diff --git a/src/types.ts b/src/types.ts
@@ -211,13 +211,15 @@ type PrismicPluginOptionsWithEndpoint = PrismicPluginOptionsBase & {
 	 * Said client will be used by `@prismicio/vue` composables, such as
 	 * {@link usePrismicDocuments} and exposed through `this.$prismic.client` and
 	 * `usePrismic().client`.
-	 * @example A repository ID:
+	 * @example
 	 *
-	 *     "my-repo";
-	 *
-	 * @example A full repository endpoint:
+	 * ```javascript
+	 * // A repository ID
+	 * "my-repo";
 	 *
-	 *     "https://my-repo.cdn.prismic.io/api/v2";
+	 * //A full repository endpoint
+	 * "https://my-repo.cdn.prismic.io/api/v2";
+	 * ```
 	 *
 	 * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
 	 */
@@ -226,17 +228,19 @@ type PrismicPluginOptionsWithEndpoint = PrismicPluginOptionsBase & {
 	/**
 	 * An optional object to configure `@prismicio/client` instance further.
 	 *
-	 * @example Accessing a private private repository:
+	 * @example
 	 *
 	 * ```javascript
+	 * // Accessing a private private repository
 	 * {
 	 * 	"accessToken": "abc"
 	 * }
 	 * ```
 	 *
-	 * @example Using a route resolver:
+	 * @example
 	 *
 	 * ```javascript
+	 * // Using a route resolver
 	 * {
 	 * 	"defaultParams": {
 	 * 		"routes": [

diff --git a/src/usePrismic.ts b/src/usePrismic.ts
@@ -7,9 +7,10 @@ import { prismicKey } from "./injectionSymbols";
 /**
  * Accesses `@prismicio/vue` plugin interface.
  *
- * @example With the composition API:
+ * @example
  *
  * ```javascript
+ * // With the composition API
  * import { usePrismic } from "@prismicio/vue";
  *
  * export default {