Fixed an issue concerning the documentation of custom properties that were always considered as statics. #947

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
2 participants
Member

ymeine commented Jan 22, 2014

The documentation of the code is generated from JSDoc comments, which are parsed with an external tool. It is possible to document let's say detached properties, and to explicitly set their names with a special tag in the JSDoc. However, the tool in question uses this name to determine if a property is attached to an instance, a prototype or is static.

Therefore I prefixed the last part of the names with the proper container name when applicable:

  • prototype for prototype members
  • instance for instance members
  • nothing for the others, which will be detected as statics (excepts for Aria members which are all considered to be in its prototype)

I took the opportunity to improve the documentation of the Modifiers class, explaining that modifier methods are not actually directly accessible.

@ghost ghost assigned jakub-g Jan 22, 2014

@ymeine ymeine referenced this pull request in ariatemplates/usermanual Jan 22, 2014

Merged

Added a warning note about modifier functions. #51

doc Properties wrongly considered static in APIDoc
The documentation of the code is generated from JSDoc comments, which are parsed with an external tool. It is possible to document let's say detached properties, and to explicitely set their names with a special tag in the JSDoc. However, the tool in question uses this name to determine if a property is attached to an instance, a prototype or is static.

Therefore I prefixed the last part of the names with the proper container name when applicable:

- "prototype" for prototype members
- "instance" for instance members
- nothing for the others, which will be detected as statics (excepts for Aria members which are all considered to be in its prototype)

I took the opportunity to improve the documentation of the Modifiers class, explaining that modifier methods are not actually directly accessible.

Closes #947

@ymeine ymeine closed this in b6a6149 Jan 23, 2014

Collaborator

jakub-g commented Jan 23, 2014

I reviewed b6a6149 and it's fine for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment