increment
', type: 'Number', description: 'Emit value of counter after increment' },
+ { name: 'decrement
', type: 'Number', description: 'Emit value of counter after decrement' },
+ ];
+
+ cy.get('[data-jsdoc-vuejs="section-event"]').contains('Events');
+ cy.get('[data-jsdoc-vuejs="table-event"]').as('table-event');
+
+ cy
+ .get('@table-event')
+ .find('> thead > tr > th')
+ .contains('Name')
+ .next().contains('Payload-type')
+ .next().contains('Description');
+
+ cy
+ .get('@table-event')
+ .find('> tbody > tr')
+ .then(($rows) => {
+ expect($rows).to.have.length(3);
+
+ events.forEach((event, i) => {
+ const $row = $rows.eq(i);
+ const $children = $row.children();
+
+ expect($children.eq(0).html()).to.eq(event.name);
+ expect($children.eq(1).html()).to.eq(event.type);
+ expect($children.eq(2).html()).to.eq(event.description);
+ });
+ });
+ });
+
it('should render methods properly', () => {
cy.contains('h3', 'Methods').should('have.attr', 'class', 'subsection-title');
diff --git a/example/src/better-components/BetterCounter.vue b/example/src/better-components/BetterCounter.vue
index 0c756d4..03e3552 100644
--- a/example/src/better-components/BetterCounter.vue
+++ b/example/src/better-components/BetterCounter.vue
@@ -19,6 +19,8 @@
* @vue-computed {Array.Name | +Payload-type | +Description | +
---|---|---|
<%- c.name %> |
+ <%- renderType(c.type) %> | +<%- typeof c.description === 'undefined' ? '-' : c.description %> | +
<%# Re-open JSDoc template tags %> diff --git a/lib/templates/docstrap.ejs b/lib/templates/docstrap.ejs index ea57206..0525841 100644 --- a/lib/templates/docstrap.ejs +++ b/lib/templates/docstrap.ejs @@ -72,4 +72,26 @@ <% } %> +<% if(event.length > 0) { %> +
Name | +Payload-type | +Description | +
---|---|---|
<%- c.name %> |
+ <%- renderType(c.type) %> | +<%- typeof c.description === 'undefined' ? '-' : c.description %> | +
<%# Re-open JSDoc template tags %> diff --git a/lib/templates/minami.ejs b/lib/templates/minami.ejs index 529806b..ed135ec 100644 --- a/lib/templates/minami.ejs +++ b/lib/templates/minami.ejs @@ -72,4 +72,26 @@ <% } %> +<% if(event.length > 0) { %> +
Name | +Payload-type | +Description | +
---|---|---|
<%- c.name %> |
+ <%- renderType(c.type) %> | +<%- typeof c.description === 'undefined' ? '-' : c.description %> | +
<%# Re-open JSDoc template tags %> diff --git a/lib/templates/tui.ejs b/lib/templates/tui.ejs index 9499013..bc964ef 100644 --- a/lib/templates/tui.ejs +++ b/lib/templates/tui.ejs @@ -91,4 +91,28 @@
Name | +Payload-type | +Description | +
---|---|---|
<%- c.name %> |
+ <%- renderType(c.type) %> | +<%- typeof c.description === 'undefined' ? '-' : c.description %> | +
<%# Re-open JSDoc template tags %>