chore(#154): update documentation

druxt · Jul 12, 2022 · ecf83b5 · ecf83b5
1 parent f8eedb9
commit ecf83b5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 7 deletions.
diff --git a/packages/breadcrumb/src/components/DruxtBreadcrumb.vue b/packages/breadcrumb/src/components/DruxtBreadcrumb.vue
@@ -44,7 +44,7 @@ export default {
      * @type {boolean}
      * @default true
      * @example @lang vue
-     * <DruxtBreacrumb :home="false" />
+     * <DruxtBreadcrumb :home="false" />
      */
     home: {
       type: Boolean,
@@ -59,7 +59,7 @@ export default {
      * @type {string}
      *
      * @example @lang vue
-     * <DruxtBreacrumb path="/node/1" />
+     * <DruxtBreadcrumb path="/node/1" />
      */
     path: {
       type: String,

diff --git a/packages/docgen/src/index.js b/packages/docgen/src/index.js
@@ -81,7 +81,7 @@ class DruxtDocgen {
       // Javascript.
       'packages/*/src/**/*.js',
       // Vue.js.
-      'packages/*/src/components/**/*.vue',
+      'packages/*/src/**/*.vue',
       // Exclude fixtures, mocks and tests.
       '!**/__*__/**/*',
     ])
@@ -216,15 +216,19 @@ _Note: The contents of this file where automatically generated by the [Druxt Doc
     const prefixId = (templateData[0] || {}).id || ''
     // Props.
     for (const prop of (data.props || []).filter((prop) => !templateData.map((o) => o.id).includes(`${prefixId}.props.${prop.name}`))) {
-      templateData.push({
+      const item = {
         id: `${prefixId}.props.${prop.name}`,
         longname: `${prefixId}.props.${prop.name}`,
         name: prop.name,
         kind: 'member',
         scope: 'static',
         description: prop.description,
-        memberof: `${prefixId}.props`
-      })
+        memberof: `${prefixId}.props`,
+      }
+      if ((prop.tags || {}).example) {
+        item.examples = [prop.tags.example[0].description.replace('DruxtModule', prefixId.split(':')[1])]
+      }
+      templateData.push(item)
     }
 
     templateData.map(item => {

diff --git a/packages/druxt/src/components/DruxtModule.vue b/packages/druxt/src/components/DruxtModule.vue
@@ -39,14 +39,25 @@ export default {
   props: {
     /**
      * The resource langcode.
+     *
+     * @example
+     * <DruxtModule langcode="en" />
+     *
+     * @type {String}
      */
     langcode: {
       type: String,
       default: undefined
     },
 
     /**
-     * The module value.
+     * The module component model value.
+     *
+     * Used to bypass the Drupal JSON:API fetch, setting the module data
+     * directly.
+     *
+     * @example
+     * <DruxtModule v-model="{ foo: bar }" />
      *
      * @type {(Array|Boolean|Date|Number|Object|String)}
      * @model