From 9438870600e3e5779f234011b9dcabd6c1cccb6c Mon Sep 17 00:00:00 2001 From: Richard Davey Date: Mon, 9 Oct 2017 11:27:20 +0100 Subject: [PATCH] Tidying up for Beta 6 release. --- v3/comments.js | 79 ----------- v3/docs/comments.json | 316 ------------------------------------------ v3/documentjs.json | 15 -- v3/package.json | 8 +- 4 files changed, 2 insertions(+), 416 deletions(-) delete mode 100644 v3/comments.js delete mode 100644 v3/docs/comments.json delete mode 100644 v3/documentjs.json diff --git a/v3/comments.js b/v3/comments.js deleted file mode 100644 index 1f167e3c14..0000000000 --- a/v3/comments.js +++ /dev/null @@ -1,79 +0,0 @@ -// https://github.com/jonschlinkert/extract-comments -// https://github.com/eslint/doctrine -// https://nodejs.org/api/fs.html -// https://github.com/jprichardson/node-fs-extra - -var fs = require('fs-extra'); -var extract = require('extract-comments'); -var beautify = require('json-beautify'); -var doctrine = require('doctrine'); - -var source = './src/gameobjects/GameObject.js'; -var dest = './docs/comments.json'; - -var doctrineOptions = { - unwrap: true, - recoverable: true, - sloppy: true, - lineNumbers: true -}; - -fs.readFile(source, 'utf8', (err, data) => { - - if (err) - { - throw err; - } - - var comments = []; - var blocks = extract.block(data); - -/* - // Example extracted docblock: - - { - "type": "block", - "range": [ 1181, 1414 ], - "loc": { "start": { "line": 37, "column": 8 }, "end": { "line": 42, "column": 11 } }, - "raw": "*\r\n * A textual representation of this Game Object, i.e. `sprite`.\r\n * Used internally by Phaser but is available for your own custom classes to populate.\r\n *\r\n * @property {string} type\r\n ", - "value": "\r\nA textual representation of this Game Object, i.e. `sprite`.\r\nUsed internally by Phaser but is available for your own custom classes to populate.\r\n\r\n@property {string} type", - "code": { - "context": { - "type": "property", - "receiver": "this", - "name": "type", - "value": "type", - "string": "this.type" - }, - "value": "this.type = type;\r", - "line": 44, - "loc": { "start": { "line": 44, "column": 1424 }, "end": { "line": 44, "column": 1442 } } - } - }, -*/ - - for (var i = 0; i < blocks.length; i++) - { - var block = blocks[i]; - - comments.push(doctrine.parse(block.value, doctrineOptions)); - } - - // comments = JSON.stringify(comments); - comments = beautify(comments, null, 2, 100); // just for debugging really - // comments = beautify(blocks, null, 2, 100); // just for debugging really - - fs.writeFile(dest, comments, { encoding: 'utf8', flag: 'w' }, function (error) { - - if (error) - { - throw error; - } - else - { - console.log('Comments written'); - } - - }); - -}); diff --git a/v3/docs/comments.json b/v3/docs/comments.json deleted file mode 100644 index 40ca506fe7..0000000000 --- a/v3/docs/comments.json +++ /dev/null @@ -1,316 +0,0 @@ -[ - { - "description": "", - "tags": [ - { "title": "author", "description": "Richard Davey ", "lineNumber": 1 }, - { "title": "copyright", "description": "2017 Photon Storm Ltd.", "lineNumber": 2 }, - { - "title": "license", - "description": "{@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}", - "lineNumber": 3 - } - ] - }, - { - "description": "", - "tags": [ - { "title": "include", "description": "Class", "lineNumber": 1 }, - { "title": "include", "description": "Components", "lineNumber": 2 }, - { "title": "include", "description": "DataProxy", "lineNumber": 3 } - ] - }, - { - "description": "The base class that all Game Objects extend.\r\nYou don't create GameObjects directly and they cannot be added to the display list.\r\nInstead, use them as the base for your own custom classes.", - "tags": [ - { - "title": "class", - "description": null, - "lineNumber": 5, - "type": null, - "name": "GameObject" - }, - { - "title": "namespace", - "description": null, - "lineNumber": 6, - "type": null, - "name": "Phaser.GameObjects" - }, - { "title": "constructor", "description": null, "lineNumber": 7, "type": null, "name": null }, - { - "title": "param", - "description": "The Scene to which this Game Object belongs.", - "lineNumber": 9, - "type": { "type": "NameExpression", "name": "Phaser.Scene" }, - "name": "scene" - }, - { - "title": "param", - "description": "A textual representation of the type of Game Object, i.e. `sprite`.", - "lineNumber": 10, - "type": { "type": "NameExpression", "name": "string" }, - "name": "type" - } - ] - }, - { - "description": "The Scene to which this Game Object belongs.\r\nGame Objects can only belong to one Scene.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "NameExpression", "name": "Phaser.Scene" }, - "name": "scene" - } - ] - }, - { - "description": "A textual representation of this Game Object, i.e. `sprite`.\r\nUsed internally by Phaser but is available for your own custom classes to populate.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "NameExpression", "name": "string" }, - "name": "type" - } - ] - }, - { - "description": "The name of this Game Object.\r\nEmpty by default and never populated by Phaser, this is left for developers to use.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "string" } }, - "name": "name", - "default": "''" - } - ] - }, - { - "description": "The active state of this Game Object.\r\nA Game Object with an active state of `true` is processed by the Scenes UpdateList, if added to it.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "boolean" } }, - "name": "active", - "default": "true" - } - ] - }, - { - "description": "The Tab Index of the Game Object.\r\nReserved for future use by plugins and the Input Manager.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "integer" } }, - "name": "tabIndex", - "default": "-1" - } - ] - }, - { - "description": "A proxy to the Data class.\r\nIt allows you to store, query and get key/value paired information specific to this Game Object.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "NameExpression", "name": "DataProxy" }, - "name": "data" - } - ] - }, - { - "description": "The flags that are compared against `RENDER_MASK` to determine if this Game Object will render or not.\r\nThe bits are 0001 | 0010 | 0100 | 1000 set by the components Visible, Alpha, Transform and Texture respectively.\r\nIf those components are not used by your custom class then you can use this bitmask as you wish.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 5, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "integer" } }, - "name": "renderFlags", - "default": "15" - } - ] - }, - { - "description": "A bitmask that controls if this Game Object is drawn by a Camera or not.\r\nNot usually set directly. Instead call `Camera.ignore`.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "number" } }, - "name": "cameraFilter", - "default": "0" - }, - { "title": "see", "description": "Phaser.Cameras.Camera.ignore", "lineNumber": 5 } - ] - }, - { - "description": "If this Game Object is enabled for input then this property will contain an InteractiveObject instance.\r\nNot usually set directly. Instead call `GameObject.setInteractive()`.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 4, - "type": { - "type": "OptionalType", - "expression": { - "type": "UnionType", - "elements": [ - { "type": "NameExpression", "name": "Phaser.Input.InteractiveObject" }, - { "type": "NullLiteral" } - ] - } - }, - "name": "input", - "default": "null" - }, - { "title": "see", "description": "setInteractive", "lineNumber": 5 } - ] - }, - { - "description": "If this Game Object is enabled for physics then this property will contain a reference to a Physics Body.", - "tags": [ - { - "title": "property", - "description": null, - "lineNumber": 3, - "type": { - "type": "OptionalType", - "expression": { - "type": "UnionType", - "elements": [ - { "type": "NameExpression", "name": "Phaser.Physics.Body" }, - { "type": "NullLiteral" } - ] - } - }, - "name": "body", - "default": "null" - } - ] - }, - { - "description": "Sets the `active` property of this Game Object and returns this Game Object for further chaining.\r\nA Game Object with its `active` property set to `true` will be updated by the Scenes UpdateList.", - "tags": [ - { "title": "method", "description": null, "lineNumber": 4, "name": "setActive" }, - { - "title": "param", - "description": "True if this Game Object should be set as active, false if not.", - "lineNumber": 6, - "type": { "type": "NameExpression", "name": "boolean" }, - "name": "value" - }, - { - "title": "return", - "description": "This GameObject.", - "lineNumber": 7, - "type": { "type": "NameExpression", "name": "GameObject" } - } - ] - }, - { - "description": "Sets the `name` property of this Game Object and returns this Game Object for further chaining.\r\nThe `name` property is not populated by Phaser and is presented for your own use.", - "tags": [ - { "title": "example", "description": "game objects/image/set name.js", "lineNumber": 4 }, - { "title": "tutorial", "description": "game objects/basics", "lineNumber": 5 }, - { "title": "method", "description": null, "lineNumber": 7, "name": "setName" }, - { - "title": "param", - "description": "The name to be given to this Game Object.", - "lineNumber": 9, - "type": { "type": "NameExpression", "name": "string" }, - "name": "value" - }, - { - "title": "return", - "description": "This GameObject.", - "lineNumber": 10, - "type": { "type": "NameExpression", "name": "GameObject" } - } - ] - }, - { - "description": "Pass this Game Object to the Input Manager to enable it for Input.", - "tags": [ - { - "title": "example", - "description": "game objects/image/set interactive.js", - "lineNumber": 3 - }, - { "title": "tutorial", "description": "input/basics", "lineNumber": 4 }, - { "title": "method", "description": null, "lineNumber": 6, "name": "setInteractive" }, - { - "title": "param", - "description": "A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.", - "lineNumber": 8, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "any" } }, - "name": "shape" - }, - { - "title": "param", - "description": "A callback to be invoked when the Game Object is interacted with.", - "lineNumber": 9, - "type": { "type": "OptionalType", "expression": { "type": "NameExpression", "name": "function" } }, - "name": "callback" - }, - { - "title": "return", - "description": "This GameObject.", - "lineNumber": 10, - "type": { "type": "NameExpression", "name": "GameObject" } - } - ] - }, - { - "description": "Returns a JSON representation of the Game Object.", - "tags": [ - { "title": "method", "description": null, "lineNumber": 3, "name": "toJSON" }, - { - "title": "return", - "description": "A JSON representation of the Game Object.", - "lineNumber": 5, - "type": { "type": "NameExpression", "name": "object" } - } - ] - }, - { - "description": "Compares the renderMask with the renderFlags to see if this Game Object will render or not.", - "tags": [ - { "title": "method", "description": null, "lineNumber": 3, "name": "willRender" }, - { - "title": "return", - "description": "True if the Game Object should be rendered, otherwise false.", - "lineNumber": 5, - "type": { "type": "NameExpression", "name": "boolean" } - } - ] - }, - { - "description": "Destroys this Game Object, removing it from the Display List and Update List.\r\nAlso removes it from the Input and Physics Managers if enabled.\r\nSets the active state to `false`. Use this to remove a Game Object from your game if\r\nyou don't plan to use it again later. If you do wish to use it later then look at using\r\nthe Game Object Pool class instead.", - "tags": [ { "title": "method", "description": null, "lineNumber": 7, "name": "destroy" } ] - }, - { - "description": "The bitmask that `GameObject.renderFlags` is compared against to determine if the Game Object will render or not.", - "tags": [ - { - "title": "constant", - "description": null, - "lineNumber": 3, - "type": { "type": "NameExpression", "name": "integer" }, - "name": "RENDER_MASK" - }, - { "title": "default", "description": null, "lineNumber": 4 } - ] - } -] \ No newline at end of file diff --git a/v3/documentjs.json b/v3/documentjs.json deleted file mode 100644 index 0bbd54fc80..0000000000 --- a/v3/documentjs.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "versionDest": "<%= version %>", - "defaultVersion": "3.0.0", - "defaultDest": "./docs", - "versions": { - "3.0.0": { - "source": "./src", - "sites": { - "docs": { - "glob" : "src/**/*.{js,md}" - } - } - } - } -} \ No newline at end of file diff --git a/v3/package.json b/v3/package.json index d12930060c..ce04789750 100644 --- a/v3/package.json +++ b/v3/package.json @@ -1,9 +1,9 @@ { - "//": "git tag 3.0.0-beta.5", + "//": "git tag 3.0.0-beta.6", "//": "git push", "//": "npm publish --tag beta", "name": "phaser", - "version": "3.0.0-beta.5", + "version": "3.0.0-beta.6", "release": "Shadow Coast", "description": "A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.", "author": "Richard Davey (http://www.photonstorm.com)", @@ -36,15 +36,11 @@ "web audio" ], "devDependencies": { - "doctrine": "^2.0.0", "eslint": "^4.3.0", "fs-extra": "^4.0.0", "uglifyjs-webpack-plugin": "^0.4.6", "uuid": "^3.1.0", "webpack": "^3.4.1", "webpack-shell-plugin": "^0.5.0" - }, - "dependencies": { - "extract-comments": "^0.10.1" } }