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

Fix issues with JSDoc generation on goog_module #5508

Closed
moniika opened this issue Sep 21, 2021 · 2 comments
Closed

Fix issues with JSDoc generation on goog_module #5508

moniika opened this issue Sep 21, 2021 · 2 comments
Assignees
Labels
issue: bug Describes why the code or behaviour is wrong type: cleanup

Comments

@moniika
Copy link
Contributor

moniika commented Sep 21, 2021

Running script for JSDoc generation on goog_module reveal some issues with the generated files:

  • Missing content
  • Pages missing fully qualified namespace (Abstract instead of Blockly.Events.Abstract)
  • Fatal error when staging to devsite (caused by empty header with empty string id)
  • Duplicated enum description (pre-existing, non-urgent issue)

This may be a matter of a bug with the process or library used to generate jsdoc or it could be an issue with the code in core.

@moniika moniika added issue: bug Describes why the code or behaviour is wrong type: cleanup labels Sep 21, 2021
@moniika moniika added this to the 2021_q3_release milestone Sep 21, 2021
@moniika moniika self-assigned this Sep 21, 2021
@moniika moniika assigned gonfunko and unassigned moniika Sep 23, 2021
@moniika moniika closed this as completed Sep 23, 2021
@moniika
Copy link
Contributor Author

moniika commented Sep 23, 2021

Still seeing issues with devsite, but missing content seems to be resolved.

@moniika
Copy link
Contributor Author

moniika commented Sep 28, 2021

Current status of jsdoc generation:

  • Pages are generating with fully qualified namespace (due to addition to @namespace and @alias)
  • No more fatal error staging after fixing @package annotation
  • Most of missing content issues have been resolved by the addition of @alias to properties
  • JSDoc for constructors is generating after adding @class annotation

Remaining issues:

  • JSDoc for private methods/properties is generated when it shouldn't
    • fix: add @private annotations
    • temporary fix: manually edit generated jsdoc
  • Missing some generated JSDoc content on pages
    • JSDoc for inherited properties missing
    • links, such as to parameter types, are missing
  • Investigate modules that have been re-exported under different namespaces (ex: Blockly.blocks.Blocks and Blockly.Blocks) and decide whether we should have jsdoc generated for both

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: bug Describes why the code or behaviour is wrong type: cleanup
Projects
None yet
Development

No branches or pull requests

4 participants