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

API JavaDoc Request #7

Open
Caltinor opened this issue Jan 21, 2024 · 0 comments
Open

API JavaDoc Request #7

Caltinor opened this issue Jan 21, 2024 · 0 comments

Comments

@Caltinor
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant