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.

Sign up for GitHub

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

Jump to bottom

"export { XXXX };" does not get API documented #442

Open

ibc opened this issue Jul 21, 2017 · 1 comment · May be fixed by #511

ibc commented Jul 21, 2017

My main index.js file has this:

import Room from './Room';

/**
 * Expose the Room class.
 */
export { Room };

However such a exported Room does not appear in the generated documentation (in the index.html itself).

Yes, still I can go to the Room documentation page which, at the top, displays import Room from 'myproject/lib/Room.js'. But I don't want to expose that way of importing this class (related to #441).

The text was updated successfully, but these errors were encountered:

Author

ibc commented Jul 22, 2017

Even worse:

export { Room as Foo };

Such a exported Foo is not documented anywhere in the HTML generated by ESDoc.

It seems that ESDoc is just focused on documenting whichever classes or modules it finds in any file rather than documenting what the library/app/code really exposes.

DeltaEvo added a commit to DeltaEvo/esdoc that referenced this issue


          Handle NamedExports of Imports, ExportAll and Export as, Close esdoc#442

05fb7ce

, Part of esdoc#361

DeltaEvo added a commit to DeltaEvo/esdoc that referenced this issue


          fix(export): Handle NamedExports of Imports, export * from and export as

51ce892

Close esdoc#442
Part of esdoc#361

DeltaEvo linked a pull request

that will close this issue

fix(export): Handle NamedExports of Imports, export * from and export as #511

Open

2 tasks

DeltaEvo added a commit to DeltaEvo/esdoc that referenced this issue


          fix(export): Handle NamedExports of Imports, export * from and export as

dd5f0a5

Close esdoc#442
Part of esdoc#361

DeltaEvo added a commit to DeltaEvo/esdoc that referenced this issue


          fix(export): Handle NamedExports of Imports, export * from and export as

5b7a4a2

Close esdoc#442
Part of esdoc#361

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