Commit graph

45 commits

Author SHA1 Message Date
photonstorm
deeb2c4942 2.2 doc files. 2014-11-15 20:01:46 +00:00
Paul
ea861662bb Documentation - YUIdoc to jsdoc, global nav
- Added support to deal with some of the YUIDoc "formats" used to
  represent arrays. It covers the case of the old PIXI documentation.

- Cleaned up log reporting and issue identification

- "Fixed" the global navigation, now that globals are displayed .. now
  just need to fix the documentation the members aren't incorrectly listed
  as globals ..
2014-11-15 04:19:41 -08:00
Paul
4ba8fe15f7 JSDoc/Docstrap generation
- "Source" section doesn't invoke a bullet, "src/" leading path removed
- Minor styles
2014-11-09 22:04:20 -08:00
Paul
69415550c1 JSDoc/Docstrap generation - cleanup
- Reverted unecessary change
2014-11-09 21:46:28 -08:00
Paul
6d274a312f JSDoc/Docstrap generation
- Made deprecated entries more apparent
  - A deprecation notice is moved above the description to make
    it actually obvious
  - The navigation item is marked (currently with line-through)
    to visual discourage even thinking about it.

- "protected" members are displayed as "internal"
  - Enforces the idea that using them from outside the core library
    is possible even though there is no public guarantee
  - There is also and advice note added to the "Deprecated/Internal"
    section reminding the users of such.

- The "Type" heading is removed when such is trivially visible in the
  type-signature of the item.

- The "Returns" section for methods is moved before the details
  (So it is displayed about the "Source" and other details.)

- The type is better integrated into "Returns"
2014-11-09 21:41:21 -08:00
Paul
a7044a6cb6 PIXI-in-Docs fixups
- Removed hard-coded path (oops)
- Added grunt task (oops)
- Added EOLs
2014-11-03 11:30:33 -08:00
Paul
343c0dca3f PIXI-in-Docs - making jshint happy 2014-11-03 11:21:00 -08:00
Paul
ce02d3402f PIXI-in-Docs - Initial
- Initial support for generating PIXI-combined documentation
- Includes yuidoc-to-jsdoc for generating pixi-jsdoc.js
- Creates doc (using pixidoc + builddoc) tasks
- Adds sourceproxy JSDoc plugin to map in corrected file/line meta
- Added yuidocjs as a dev-dependency
2014-11-03 11:05:00 -08:00
Paul
96915e1612 JSDoc Property to member - slight combining update 2014-11-03 08:27:50 -08:00
Paul
e6da96e908 Added "property to member" plugin for JSDoc
This automatically fixes usage of the form

    /** desc
    * @property {T} name - desc

To

    /** desc
    * @member {T} name

Being careful to only make the transformation when it is logical to do and preserving both descriptions as appropriate.
2014-11-03 03:13:01 -08:00
photonstorm
d44424fdbc 2.1.3 documentation updates. 2014-10-22 21:49:44 +01:00
photonstorm
9f24c08216 Updated readme and docs. 2014-10-09 16:12:53 +01:00
photonstorm
26fe06e00c Docs updates. 2014-09-09 15:36:56 +01:00
photonstorm
1924a83b99 New docs generated. 2014-07-18 12:45:51 +01:00
photonstorm
8421cfc400 Final readme updates. 2014-07-10 20:39:17 +01:00
photonstorm
4259a9ae14 Republished docs. 2014-07-10 20:39:17 +01:00
photonstorm
dbeda43aa5 Docs rebuilt for 2.0.5 2014-05-20 10:12:48 +01:00
photonstorm
ba3f6355f4 Docs update. 2014-04-29 15:39:02 +01:00
photonstorm
1326e40598 Build files + docs update. 2014-04-15 15:39:23 +01:00
photonstorm
cdff873cf7 Updated change log and readme headers. 2014-04-11 13:28:17 +01:00
photonstorm
4cea8d7bcc Preparing for final 2.0.3 release. Updated docs, readme and build files. 2014-04-11 13:09:28 +01:00
STuFF
3376956657 re-generated documentation 2014-04-11 00:13:43 +02:00
STuFF
c24b6e6f1c documentation template : classes names indentation 2014-04-11 00:11:26 +02:00
photonstorm
5b73bb21bb Sprite would glitch if it had an ArcadePhysics Body that was re-positioned out of loop.
Sprite would "fly off" if it had an ArcadePhysics Body that was re-positioned during an input handler.
Newly generated docs
2014-03-28 01:42:49 +00:00
photonstorm
7eee1eac1f Updated docs to 2.0.1. 2014-03-24 12:41:45 +00:00
photonstorm
1746afe477 Merged 1.2 branch into master for the final Phaser v2.0.0 release. 2014-03-14 06:43:52 +00:00
photonstorm
901a7f13d1 Updated docs for 2.0 release and updated README. 2014-03-14 06:36:05 +00:00
photonstorm
c73b4eaea0 json is now the default tilemap format when not defined (thanks RyanDansie, #528)
Updated docstrap
2014-03-10 00:50:06 +00:00
photonstorm
9d9fd06392 Tidying up the repo, moving old wip stuff out, clearing up the docs. 2014-02-24 12:14:31 +00:00
photonstorm
f4ff4d88fe 1.1.6 release. The final of the 1.1 branch. 2014-02-24 01:28:13 +00:00
photonstorm
e9e5bf9436 Updated docs - they now actually list the new body methods :) 2014-02-21 15:37:26 +00:00
photonstorm
7394403bb6 Fresh build. Updated docs and re-built phaser.js. 2014-02-19 05:28:19 +00:00
photonstorm
5d5c64d22f Tilemap.createCollisionObjects will parse Tiled data for objectgroups and convert polyline instances into physics objects you can collide with in the world.
After defining tiles that collide on a Tilemap, you need to call Tilemap.generateCollisionData(layer) to populate the physics world with the data required.
Debug.renderPhysicsBody updated to take camera location and body rotation into account.
Body movement functions put back to velocity :)
Updated to latest dev version of pixi and latest p2.js
Updated docs
2014-02-18 03:01:51 +00:00
photonstorm
0641170aab Explicitly paused Timer continues if you un-focus and focus the browser window (thanks georgiee)
Added TimerEvent.pendingDelete and checks in Timer.update, so that removing an event in a callback no longer throws an exception (thanks georgiee)
Fixed TypeScript defs on lines 1741-1748 (thanks wombatbuddy)
Added SAT.js to TypeScript definition. Now compiles properly.
Added missing Line.js to the Grunt file.
Tilemap#paste diffX and diffY equations changed, fixed issue #393 (thanks brejep)
Added missing return value in Body.hitLeft and hitRight, fixes issue #398 (thanks ram64).
Fixed easing tween example case. Issue #379 (thanks wesleywerner)
Removed SAT.js UMD wrapped, fixes issue #361 (thanks luizbills)
Removed inContact check from Body.separate.
Fixed Tilemap docs (wrongly pointed to Tileset methods)
2014-02-12 15:33:31 +00:00
photonstorm
d9323de752 Docs and Examples update. 2014-02-12 15:26:29 +00:00
photonstorm
ee3f6d8e7f Tilemap had the wrong @method signatures so most were missing from the docs. 2014-02-08 07:24:40 +00:00
photonstorm
02b75b9e23 Updated doc files. 2014-02-05 16:55:02 +00:00
photonstorm
f22159e257 Updated documentation. 2013-11-28 15:57:09 +00:00
photonstorm
a9a46bfbbf Lots of documentation updates and new Loader examples. 2013-11-27 16:33:49 +00:00
photonstorm
3f99b691c9 Added in a Group.sort demo, also updated the documentation and build files. 2013-11-07 06:10:15 +00:00
photonstorm
3e9777e6f4 Updated docs for 1.1.2 release. 2013-11-01 18:16:52 +00:00
photonstorm
ddf15979d0 Fixing up Invaders and Star Struck. Also removing lots of un-used css jsdoc themes. 2013-10-31 01:45:16 +00:00
photonstorm
65d2bf557b Updated docs and more tidying up. 2013-10-25 17:30:37 +01:00
photonstorm
9f9e6a2a57 Lots of doc updates! 2013-10-25 16:54:40 +01:00
photonstorm
ffd5ddc534 Tidying up the repo and adding in new documentation. 2013-10-23 14:00:29 +01:00