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

How to describe interface with properties? #280

Open
VityaSchel opened this issue Apr 29, 2022 · 2 comments
Open

How to describe interface with properties? #280

VityaSchel opened this issue Apr 29, 2022 · 2 comments

Comments

@VityaSchel
Copy link

VityaSchel commented Apr 29, 2022

If I have an interface

interface Dog {
  name: string
  age: number
}

How to document it with JSDoc so this lib can parse it?

My failed attempt was

/**
 * An animal, human friend
 * @interface Dog
 * @property {string} name
 * @property {number} age
 * @memberof module:modulename
 */
interface Dog {
  name: string
  age: number
}
@75lb
Copy link
Member

75lb commented Apr 30, 2022

Does your failed attempt above work in jsdoc? If not, please ensure your docs generate correctly in jsdoc first (jsdoc2md works downstream of jsdoc)..

@aureq
Copy link

aureq commented Sep 19, 2023

I think @75lb the question has more to do with "How do I get an interface documentation in the resulting output" rather than something is not working.

In my situation, it all works fine but somehow interface is not where to be found in the output, and there's no error message either. Perhaps you have an example somewhere you could share? Or there's a specific setting that needs to be turned on?

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants