Skip to content

Commit

Permalink
Added in the JS source files for doc generation and the definitions t…
Browse files Browse the repository at this point in the history
…o csproj XML script.
  • Loading branch information
photonstorm committed Aug 9, 2013
1 parent 1248a6c commit 9bf7d07
Show file tree
Hide file tree
Showing 135 changed files with 24,594 additions and 22,547 deletions.
Binary file added Docs/phaser_copy.doc
Binary file not shown.
145 changes: 145 additions & 0 deletions Docs/tags.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/**
* Name
*
* Long description
*
* @package Phaser.
* @author Richard Davey <[email protected]>
* @copyright 2013 Photon Storm Ltd.
* @license https://github.com/photonstorm/phaser/blob/master/license.txt MIT License
*/


@param {Type} Name Description
Object, Array, String, Boolean, Number, Mixed, MyType

@module Phaser.Components

@class Animation
@constructor

@event signal details here
@param {Type} paramName

/**
* Property description
* @property game
* @type Phaser.Game
* @protected / @public / @private
* @static
* @default
*/

@default could be:

@default {object: 0, blah: 1}
@default Boolean

/**
* Description of the method
* @method blahBlah
* @param {Type} name The description
* @return {Type} the description
*/


@abstract
This member must be implemented (or overridden) by the inheritor.

@access
Specify the access level of this member - private, public, or protected.

@author
Identify the author of an item.

@callback
Document a callback function.

@classdesc
Use the following text to describe the entire class.

@constant
Document an object as a constant.

@constructor
This function is intended to be called with the "new" keyword.

@copyright
Document some copyright information.

@default
Document the default value.

@deprecated
Document that this is no longer the preferred way.

@desc
Describe a symbol.

@enum
Document a collection of related properties.

@event
Document an event.

@example
Provide an example of how to use a documented item.

@link
Inline tag - create a link.
@member
Document a member.
@memberof
This symbol belongs to a parent symbol.
@method
Describe a method or function.
@mixes
This object mixes in all the members from another object.
@mixin
Document a mixin object.
@module
Document a JavaScript module.
@name
Document the name of an object.
@namespace
Document a namespace object.
@param
Document the parameter to a function.
@private
This symbol is meant to be private.
@property
Document a property of an object.
@protected
This member is meant to be protected.
@public
This symbol is meant to be public.
@readonly
This symbol is meant to be read-only.
@requires
This file requires a JavaScript module.
@returns
Document the return value of a function.
@see
Refer to some other documentation for more information.
@since
When was this feature added?
@static
Document a static member.
@summary
A shorter version of the full description.
@this
What does the 'this' keyword refer to here?
@throws
Describe what errors could be thrown.
@todo
Document tasks to be completed.
@tutorial
Insert a link to an included tutorial file.
@type
Document the type of an object.
@typedef
Document a custom type.
@variation
Distinguish different objects with the same name.
@version
Documents the version number of an item.
39 changes: 39 additions & 0 deletions Phaser/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

#ignore thumbnails created by windows
Thumbs.db
#Ignore files build by Visual Studio
*.obj
*.exe
*.pdb
*.user
*.aps
*.pch
*.vspscc
*_i.c
*_p.c
*.ncb
*.suo
*.sln
*.tlb
*.tlh
*.bak
*.cache
*.ilk
*.log
*.map
*.orig
*.map
*.config
*.sublime-workspace
.DS_Store
launcher.html
tests.html
[Bb]in
[Dd]ebug*/
*.lib
*.sbr
obj/
[Rr]elease*/
_ReSharper*/
[Tt]est[Rr]esult*
.idea/
Loading

0 comments on commit 9bf7d07

Please sign in to comment.