Skip to content

Reference documentation for Blockly.Events.* methods and constants is mostly useless #8586

@cpcallen

Description

@cpcallen

Check for duplicates

  • I have searched for similar issues before opening a new one.

Description

The documentation for many of the constants and methods on Blockly.Events is more or less useless, describing all of these as variables (rather than constants / methods) and providing only uninformative type information). For example, Blockly.Events.setGroup is useless described as](https://developers.google.com/blockly/reference/js/blockly.events_namespace.setgroup_variable.md):

Events.setGroup variable

Signature:

setGroup: typeof eventUtils.setGroup

This is probably due to some interaction between how we reexport these methods and how API Extractor works and likely affects much of the rest of our documentation as well.

N.B.: How these methods are exported was changed in #8530 (to use export … from …), which might or might not be relevant.

Metadata

Metadata

Assignees

No one assigned

    Labels

    issue: bugDescribes why the code or behaviour is wrongissue: docsDescribes missing or incorrect documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions