Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to force vuese to ignore some comments? #197

Open
Radouch opened this issue Sep 7, 2020 · 1 comment
Open

Is it possible to force vuese to ignore some comments? #197

Radouch opened this issue Sep 7, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@Radouch
Copy link

Radouch commented Sep 7, 2020

I want to write some comments just for structuring my *.vue component, which should not be included in the documentation created by Vuese.

Let us say my code looks like:

export default class BaseTable extends Vue {
  /* ==PROPS== */

  // @vuese
  // id is needed for b-collapse
  @Prop({
    required: true,
  })
  id!: string;

Unfortunatelly, Vuese does include /* ==PROPS== */ into description of id prop.
Is there any way to prevent this behaviour?

I am using @vuese/cli

@IWANABETHATGUY IWANABETHATGUY added the enhancement New feature or request label Sep 7, 2020
@Radouch
Copy link
Author

Radouch commented Sep 8, 2020

By chance I have found a solution. It seems that Vuese ignores JSDoc tags, so we can use e.g. @ignore.

My example will then be:

export default class BaseTable extends Vue {
  /* @ignore ==PROPS== */

  // @vuese
  // id is needed for b-collapse
  @Prop({
    required: true,
  })
  id!: string;

Should be added to the documentation, I guess.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants