Page MenuHomeWildfire Games

Add JSdoc to AuraManager
Needs ReviewPublic

Authored by elexis on Jan 5 2018, 9:48 PM.
This revision needs review, but there are no reviewers specified.

Details

Reviewers
None
Summary

Since it's not self-evident what those parameters mean, provide examples. Also adds some sentences for good measure, though they don't seem to add information.

Test Plan

Read.

Event Timeline

elexis created this revision.Jan 5 2018, 9:48 PM
Vulcan added a subscriber: Vulcan.Jan 5 2018, 9:50 PM
Executing section Default...
Executing section Source...
Executing section JS...
Vulcan added a comment.Jan 5 2018, 9:52 PM

Successful build - Chance fights ever on the side of the prudent.

Updating workspaces...
Build (release)...
Build (debug)...
Running release tests...
Running cxxtest tests (308 tests)....................................................................................................................................................................................................................................................................................................................OK!
Running debug tests...
Running cxxtest tests (308 tests)....................................................................................................................................................................................................................................................................................................................OK!
Checking XML files...
bb added a subscriber: bb.Jan 7 2018, 10:51 PM

Having some explanation of the parameters and a sentence about every function seems nice, maybe put the parameter explanations as a "global" in the head, don't know if some jsDoc parser likes that.

binaries/data/mods/public/simulation/components/AuraManager.js
2

it doesn't cache templates, right? but classes

33

Autistic screeching dislikes starting with "This function"

41

return?

74

newdata sounds like replacing, which doesn't happen

no duplication for same arguments

112

what an example :P

196

template names => classes

232

(we seem to have a long sentence)

249

on a template