Add JSdoc to AuraManager
AbandonedPublic
Actions

Authored by elexis on Jan 5 2018, 9:48 PM.

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.

Diff Detail

Repository

rP 0 A.D. Public Repository

Branch

/ps/trunk

Lint

Lint OK

Unit

No Unit Test Coverage

Build Status

Buildable 4331
Build 7596: Vulcan Build (Windows)	Jenkins
Build 7595: Vulcan Build	Jenkins
Build 7594: arc lint + arc unit

Event Timeline

elexis created this revision.Jan 5 2018, 9:48 PM

Executing section Default...
Executing section Source...
Executing section JS...

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...

Harbormaster completed remote builds in B4331: Diff 5096.Jan 5 2018, 9:52 PM

elexis mentioned this in D1201: AuraManager shouldn't serialize the affected classes array directly.Jan 6 2018, 3:27 AM

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

There is no longer any need. The file was deleted.
Superseded by the new modifications manager: D274 / rP22767

Stan abandoned this revision.Mar 28 2020, 1:41 PM

Revision Contents
Changeset List

Path

Size

binaries/

data/

mods/

public/

simulation/

components/

AuraManager.js

37 lines

Diff 5096

View Options

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

Add JSdoc to AuraManagerAbandonedPublicActions