Skip to content

Commit 9bf7d07

Browse files
committed
Added in the JS source files for doc generation and the definitions to csproj XML script.
1 parent 1248a6c commit 9bf7d07

135 files changed

Lines changed: 24594 additions & 22547 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Docs/phaser_copy.doc

29.5 KB
Binary file not shown.

Docs/tags.txt

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
/**
2+
* Name
3+
*
4+
* Long description
5+
*
6+
* @package Phaser.
7+
* @author Richard Davey <rich@photonstorm.com>
8+
* @copyright 2013 Photon Storm Ltd.
9+
* @license https://github.com/photonstorm/phaser/blob/master/license.txt MIT License
10+
*/
11+
12+
13+
@param {Type} Name Description
14+
Object, Array, String, Boolean, Number, Mixed, MyType
15+
16+
@module Phaser.Components
17+
18+
@class Animation
19+
@constructor
20+
21+
@event signal details here
22+
@param {Type} paramName
23+
24+
/**
25+
* Property description
26+
* @property game
27+
* @type Phaser.Game
28+
* @protected / @public / @private
29+
* @static
30+
* @default
31+
*/
32+
33+
@default could be:
34+
35+
@default {object: 0, blah: 1}
36+
@default Boolean
37+
38+
/**
39+
* Description of the method
40+
* @method blahBlah
41+
* @param {Type} name The description
42+
* @return {Type} the description
43+
*/
44+
45+
46+
@abstract
47+
This member must be implemented (or overridden) by the inheritor.
48+
49+
@access
50+
Specify the access level of this member - private, public, or protected.
51+
52+
@author
53+
Identify the author of an item.
54+
55+
@callback
56+
Document a callback function.
57+
58+
@classdesc
59+
Use the following text to describe the entire class.
60+
61+
@constant
62+
Document an object as a constant.
63+
64+
@constructor
65+
This function is intended to be called with the "new" keyword.
66+
67+
@copyright
68+
Document some copyright information.
69+
70+
@default
71+
Document the default value.
72+
73+
@deprecated
74+
Document that this is no longer the preferred way.
75+
76+
@desc
77+
Describe a symbol.
78+
79+
@enum
80+
Document a collection of related properties.
81+
82+
@event
83+
Document an event.
84+
85+
@example
86+
Provide an example of how to use a documented item.
87+
88+
@link
89+
Inline tag - create a link.
90+
@member
91+
Document a member.
92+
@memberof
93+
This symbol belongs to a parent symbol.
94+
@method
95+
Describe a method or function.
96+
@mixes
97+
This object mixes in all the members from another object.
98+
@mixin
99+
Document a mixin object.
100+
@module
101+
Document a JavaScript module.
102+
@name
103+
Document the name of an object.
104+
@namespace
105+
Document a namespace object.
106+
@param
107+
Document the parameter to a function.
108+
@private
109+
This symbol is meant to be private.
110+
@property
111+
Document a property of an object.
112+
@protected
113+
This member is meant to be protected.
114+
@public
115+
This symbol is meant to be public.
116+
@readonly
117+
This symbol is meant to be read-only.
118+
@requires
119+
This file requires a JavaScript module.
120+
@returns
121+
Document the return value of a function.
122+
@see
123+
Refer to some other documentation for more information.
124+
@since
125+
When was this feature added?
126+
@static
127+
Document a static member.
128+
@summary
129+
A shorter version of the full description.
130+
@this
131+
What does the 'this' keyword refer to here?
132+
@throws
133+
Describe what errors could be thrown.
134+
@todo
135+
Document tasks to be completed.
136+
@tutorial
137+
Insert a link to an included tutorial file.
138+
@type
139+
Document the type of an object.
140+
@typedef
141+
Document a custom type.
142+
@variation
143+
Distinguish different objects with the same name.
144+
@version
145+
Documents the version number of an item.

Phaser/.gitignore

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
#ignore thumbnails created by windows
3+
Thumbs.db
4+
#Ignore files build by Visual Studio
5+
*.obj
6+
*.exe
7+
*.pdb
8+
*.user
9+
*.aps
10+
*.pch
11+
*.vspscc
12+
*_i.c
13+
*_p.c
14+
*.ncb
15+
*.suo
16+
*.sln
17+
*.tlb
18+
*.tlh
19+
*.bak
20+
*.cache
21+
*.ilk
22+
*.log
23+
*.map
24+
*.orig
25+
*.map
26+
*.config
27+
*.sublime-workspace
28+
.DS_Store
29+
launcher.html
30+
tests.html
31+
[Bb]in
32+
[Dd]ebug*/
33+
*.lib
34+
*.sbr
35+
obj/
36+
[Rr]elease*/
37+
_ReSharper*/
38+
[Tt]est[Rr]esult*
39+
.idea/

0 commit comments

Comments
 (0)