How do I comment an entire file in JSDoc?
Asked Answered
A

0

9

I'm trying to comment an entire file describing an overall functionality. I put something like this at the top of each file

/**
 * @file File with helper functions that facilitate reading config JSON files.
 */

but when I generate the documentation I end up with a weird Index headline before every file. It looks like this:

I didn't make any changes to default JSDoc configuration. Am I doing something wrong? What's that Index headline? Can I get rid of it or change it to something meaningful?

Archaeology answered 26/10, 2018 at 7:25 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.