-
Notifications
You must be signed in to change notification settings - Fork 485
Empty documentation is built. #424
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
Comments
This file doesn't have any JSDoc annotations, so there isn't anything to generate. You will need to add documentation to your files, as explained in getting started, in order to produce documentation. |
Oh, I thought it would still generate something from the type annotations. It doesn't work very well with es6 module syntax though: /**
* Description
*/
export function func() {} does not work, but export
/**
* Description
*/
function func() {} does. |
This makes sure that we get the name and params from exported functions/classes/vars. For export default the name is inferred from the file name. Towards documentationjs#424
This adds a boolean flag called `document-exported` (defaults to false) that effectively adds an empty comment to all exported bindings that do not already have a JSDoc comment. It also goes does the same for the members of exported classes and objects. ```js export class C { method() {} } ``` Both `C` and `C#method` are now part of the generated documentation. Related to documentationjs#424
This adds a boolean flag called `document-exported` (defaults to false) that effectively adds an empty comment to all exported bindings that do not already have a JSDoc comment. It also does the same for the members of exported classes and objects. ```js export class C { method() {} } ``` Both `C` and `C#method` are now part of the generated documentation. Related to documentationjs#424
This adds a boolean flag called `document-exported` (defaults to false) that effectively adds an empty comment to all exported bindings that do not already have a JSDoc comment. It also does the same for the members of exported classes and objects. ```js export class C { method() {} } ``` Both `C` and `C#method` are now part of the generated documentation. Related to documentationjs#424
* Add a flag to document all exported bindings This adds a boolean flag called `document-exported` (defaults to false) that effectively adds an empty comment to all exported bindings that do not already have a JSDoc comment. It also does the same for the members of exported classes and objects. ```js export class C { method() {} } ``` Both `C` and `C#method` are now part of the generated documentation. Related to #424 * Fix lint error * Rebase and use options pragma in test file * Create extractor type as a generalized comment/export getter * Document exported extractor
This is resolved in #502! Exported functionality is now documentable by default. |
Not really by default... you have to pass the command line flag/option. |
…ionjs#424) * Add initial section for tooling * Remove unneeded whitespace * Add some initial updates for core libraries * Add section for contrib, node, and web libraries * Add 'replace with Type.Proxy' note * Drop prepare-0.15 package set note * Link to es modules script The above guide doesn't mention the issue with "use strict"; not getting dropped. Not sure if we should mention it here explicitly, but my script accounts for that. At the same time, my script uses bash commands that may not work the same on MacOS * Add note about export renaming
When running documentation on this file, using the command
documentation build src/speedball.js
, it fails.Firstly it errors, saying that
export const __esModule = true;
is invalid. If I comment out that, I just get an empty array returned.EDIT: I think the error saying the __esModule export is invalid might be correct, but the second problem is still valid.
The text was updated successfully, but these errors were encountered: