From 1043786:
"For TransitionEvent, I'm interpreting that @private tag as referring to the constructor in particular, that is, one isn't supposed to instantiate that class.
However, as I understand it, the static fields like TransitionEvent.BUILTIN, TransitionEvent.MW_HOOK, etc., are what is provided as arguments to the callback parameter of the public and user facing StepBuilder::transition method. So we probably want them to be documented where they are defined."
To do
This task is for the GuidedTour extension. For contributing instructions, see Gerrit/Tutorial.
- In ext.guidedTour.lib.TransitionEvent.js, modify the JSDoc annotations so the properties appear on mw.guidedTour.TransitionEvent and can be referenced from StepBuilder::transition. Run npm run doc to build the docs locally.
- Add a @hideconstructor tag to ext.guidedTour.lib.TransitionEvent.js since the constructor is marked as private
Approach
In my initial testing, I was only able to get the properties to appear corectly using a forced memberof annotation (@memberof!), but there may be a better way to do this.