Skip to content

Breaks standard documentation for mixins #169

@turboteddy

Description

@turboteddy

Thanks for the good work. I'm not sure why, but when I try to documents methods of a mixin, these aren't displayed:

/**
 * Description 
 * @mixin   mixins/somename
 * @vue-computed {*}           comp1              DOCUMENT ME!
 * @vue-computed {*}           comp2              DOCUMENT ME!
 */
export default {

  computed: {
    ...mapGetters([
      'comp1',
      'comp2'
    ])
  },

  methods: {

    /**
     * DOCUMENT ME!
     *
     * @function foo
     * @memberof mixins/somename
     * @instance
     *
     * @param a
     * @param b=null
     * @returns {*}
     */
    foo(a,b=null) {
        //....
    }
  }
};

Also tried with...

/**
 * Description
 * @module  mixins/somename
 * @mixin
 * @vue-computed {*}           comp1              DOCUMENT ME!
 * @vue-computed {*}           comp2              DOCUMENT ME!
 */

If I drop the vue-tags, it works (i.e. the function foo is shown in output).

Is this a bug, or did I misunderstand something (must admit that I'm very new to Vue)? It works if I drop the @mixin tag, but then it's no longer labelled as a mixin.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions