Skip to content

Option to automatically group files in modules #234

@killercup

Description

@killercup

I'm a big fan on inferring documentation properties from code: I'm using documentation.js mainly because it allows me to omit the ‘boring’ parts of doc comments by using Flow types. Similarly, since my code uses CommonJS/ES2015 import/exports, I've never seen the value in manually adding JSDoc's @module tag to all my files.

Thus, I want to suggest a new option for documentation.js: Infer modules from file names.

Let's say I have a src/foo/bar.js. Its module name is the same as the name I can require() or import it with, i.e. foo/bar.

I'm not sure what your plans for handling modules/grouping documentation items is in general, but for larger projects, I'd like to see a documentation.js theme that lists entries in a tree instead of a flat list.

Ideally, this would also allow me to see which items are exported from a module.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions