Skip to content

API JavaDoc Request #7

@Caltinor

Description

@Caltinor

Can the following classes/methods be given JavaDocs to help developers?

  • AlembicDamageModificationEvent
  • AlembicDamageEvent
  • AlembicFoodChangeEvent
  • AlembicAPI#getDamageType
  • AlembicAPI#activatePreEvent
  • AlembicAPI#activatePostEvent

Alternatively, though not ideally, the Wiki could be expanded to better explain the context in which these events and hooks are used/fired to give a better understanding to those less familiar with the codebase. This will be especially helpful for modders making addons/compat so that when changes are made to the underlying codebase an intimate understanding of those changes is not required to maintain compatibility.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions