wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-12 09:09:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Visual.../.docs/categories.json

227 lines
3.6 KiB
JSON
Raw Normal View History

JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
[
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "VisualEditor (MediaWiki extension)",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"groups": [
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "Initialization",
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
"classes": [
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"ve.init.mw*",
"ve.version"
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
]
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
},
Great Annotation Refactor of 2013 This changes the annotation API to be the same as the node API, sans a few boolean flags that don't apply. The APIs were different, but there was really no good reason why, so this makes things simpler for API users. It also means we'll be able to factor a bunch of things out because they're now duplicated between nodes, meta items and annotations. Linear model annotations are now objects with 'type' and 'attributes' properties (rather than 'name' and 'data'), for consistency with elements. They now also contain html/0/* attributes for HTML attribute preservation, which obsoletes the htmlTagName and htmlAttributes properties. dm.Annotation subclasses take a reference to such an object and implement conversion using .static.toDataElement and .static.toDomElements just like nodes do. The custom .getHash() functions are no longer necessary because of the way HTML attribute preservation was reimplemented. CE rendering has been moved out of dm.Annotation (it never made sense to have CE rendering functions in DM classes, this was bothering me) and into separate ce.Annotation subclasses. These are very similar to CE nodes in that they have a this.$ generated based on something in the DM; the main difference is that nodes listen to events and update themselves, whereas annotations are static and are simply destroyed and rebuilt when they change. This change also adds whitelisted HTML attribute rendering for annotations, as well as class="ve-ce-FooAnnotation" attributes. Now that annotation classes produce real DOM nodes rather than weird objects describing HTML tags, we can't generate HTML as a string in ce.ContentBranchNode anymore. getRenderedContents() has been rewritten to be much more similar to the way the converter renders annotations; in fact, significant parts of it were copied from the converter, so that should be factored out in the future. This change actually fixes an annotation rendering discrepancy between ce.ContentBranchNode and dm.Converter; see the diff of ve.ce.ContentBranchNode.test.js. ve.ce.MWEntityNode.js: * Remove stray property ve.dm.MWExternalLinkAnnotation.js: * Store 'rel' attribute ve.dm.TextStyleAnnotation.js: * Put all the conversion logic in the abstract base class ve.dm.Converter.js: * Also feed annotations through getDomElementsFromDataElement() and createDataElement() ve.dm.Node.js: * Fix undocumented property ve.ce.ContentBranchNode.test.js: * Add descriptive messages for each test case * Compare DOM trees, not HTML strings * Compare without all the class="ve-ce-WhateverAnnotation" clutter ve.ui.LinkInspector.js: * Replace direct .getHash() calls (evil!) with ve.getHash() Bug: 46464 Bug: 44808 Change-Id: I31991488579b8cce6d98ed8b29b486ba5ec38cdc
2013-04-02 17:23:33 +00:00
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "User Interface",
"classes": [
"ve.ui.MW*Page"
]
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
}
]
},
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "VisualEditor (core)",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"groups": [
{
"name": "General",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"ve",
"ve.Range",
"ve.EventSequencer",
"ve.Node",
"ve.BranchNode",
"ve.LeafNode",
The great image scaling rewrite of 2014 (MW) Implement new logic in ve.Scalable from I5b4f0f91b. Also update VE core submodule to master (57ed8d3). New changes: 59a0afe The great image scaling rewrite of 2014 Change-Id: I24a2976036310d3814cc7d1853a68745e0499bd5
2014-01-26 20:09:40 +00:00
"ve.Document",
"ve.Scalable"
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
]
},
{
"name": "Initialization",
"classes": [
"ve.init",
"ve.init.Platform",
"ve.init.Target",
"ve.init.sa*"
]
},
{
"name": "DataModel",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"classes": [
"ve.dm",
Move common Node/Annotation/MetaItem code into ve.dm.Model ve.dm.Model is now the common base class for these three. ve.dm.Node inherited from ve.Node before, so it now uses it as a mixin instead. This required changing ve.Node's usage of ve.EventEmitter from inhertiance to a mixin as well, because inherited methods apparently don't get mixed in correctly. * Change annotation terminology from linmodAnnotation to element for consistency with Node, MetaItem and Model * Reimplement getClonedElement() in Node for .internal treatment Change-Id: Ifd3922af23557c0b0f8984d36b31c8a1e2ec497e
2013-04-02 18:28:42 +00:00
"ve.dm.Model",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"ve.dm.AnnotationFactory",
Add MetaList A MetaList is a collection of MetaItems representing all of the metadata in a ve.dm.Document, and it updates itself live as the underlying document changes. Currently this interface is read-only, I'll add mutators next. Change-Id: If7bfc9563af37e22dcdca9a682d6decc2f6f1872
2013-03-15 04:07:23 +00:00
"ve.dm.MetaItemFactory",
Move matching code from AnnotationFactory to ModelRegistry ModelRegistry registers both annotations and nodes, and performs matching on both at the same time. It also registers annotations with the AnnotationFactory, and nodes with the NodeFactory. Change-Id: I5e68e506a0e573cc0afe6304ccea058ffc20d1c8
2013-01-18 05:29:01 +00:00
"ve.dm.ModelRegistry",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"ve.dm.Converter",
UnicodeJS library to implement Unicode standards Initially just with a Wordbreak module to implement Unicode standard on 'Default Word Boundaries'. Due to it's standaloneability this has been written as a separate library. Non-BMP characters are currently not supported. Bug: 44085 Change-Id: Ieafa070076f4c36855684f6bc179667e28af2c25
2013-03-18 11:31:14 +00:00
"ve.dm.DataString",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"ve.dm.DocumentSynchronizer",
Store data in LinearData class with an index-value store for objects Created an IndexValueStore class which can store any object and return an integer index to its hash map. Linear data is now stored in ve.dm.LinearData instances. Two subclasses for element and meta data contain methods specific to those data types (ElementLinearData and MetaLinearData). The static methods in ve.dm.Document that inspected data at a given offset are now instance methods of ve.dm.ElementLinearData. AnnotationSets (which are no longer OrderedHashSets) have been moved to /dm and also have to be instantiated with a pointer the store. Bug: 46320 Change-Id: I249a5d48726093d1cb3e36351893f4bff85f52e2
2013-03-20 22:35:05 +00:00
"ve.dm.IndexValueStore",
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
"ve.dm.NodeFactory",
"ve.dm.Surface",
"ve.dm.SurfaceFragment",
"ve.dm.Transaction",
"ve.dm.TransactionProcessor",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"ve.dm.TransactionProcessor.processors",
"ve.dm.*Annotation",
"ve.dm.AnnotationSet",
"ve.dm.*MetaItem",
"ve.dm.MetaList",
"ve.dm.InternalList",
"ve.dm.Document*",
"ve.dm.*Node",
"ve.dm.*LinearData*",
"ve.dm.*Model"
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
]
},
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "ContentEditable",
"classes": [
"ve.ce",
"ve.ce.View",
"ve.ce.AnnotationFactory",
"ve.ce.NodeFactory",
"ve.ce.Surface",
"ve.ce.SurfaceObserver",
"ve.ce.DomRange",
"ve.ce.*Annotation",
"ve.ce.Document",
"ve.ce.*Node"
]
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
},
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "User Interface",
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
"classes": [
"ve.ui",
ve.Editor Objectives: * Split ve.Surface into ve.Editor and ve.ui.Surface * Move actions, triggers and commands to ve.ui * Move toolbar wrapping, floating, shadow and actions functionality to configurable options of ve.ui.Toolbar * Make ve.ce.Surface and ve.ui.Surface inherit ve.Element and use this.$$ for iframe friendliness * Make the toolbar separately initialized so it's possible to have a surface without one, as well as control where the toolbar is Some change notes: VisualEditor.php * Added standalone module for mediawiki integrated unit testing ve.ce.Surface.js * Remove requirement to pass in an attached container to construct object * Inherit ve.Element and use this.$$ instead of $ * Make getSelectionRect iframe friendly * Move most of the initialize stuff to a new initialize method to be called after the surface is attached to the DOM ve.init.mw.ViewPageTarget.js * Merge toolbar functions into setup/teardown methods * Add toolbar manually (since it's not added by the surface anymore) ve.init.sa.Target.js * Update new init procedure for editor, surface and toolbar separately * Move toolbar floating stuff to ve.Toolbar Change-Id: If91a9d6e76a8be8d1b5a2566394765a37d29a8a7
2013-05-14 23:45:42 +00:00
"ve.ui.Surface",
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
"ve.ui.Context",
Window refactor Changes: * Cleanup the window API to use more consistent and intuitive methods - we now use initialize/setup/teardown instead of initialize/onSetup/onOpen/onClose as methods which are overridden, and use open/close methods to control the window * Change events around to have opening/open and closing/close events which act as before/after points during the opening/closing process * Make WindowSet and Context respond to windows being opened, rather than opening them directly * Fix a LinkInspector creation mode bug where the initial text doesn't get reset * Move inspector, a VisualEditor concept, back to VE * Cleanup naming of SurfaceDialog, SurfaceToolbar, etc. to use shorter names, they were given Surface* names when the generic ones were also in VE, but now the generic ones are in OO, so they can return to their original names Change-Id: I82c4fed8bcb3fb5630938c8bc4dd9b2d5f1a8c1d
2013-11-05 00:29:50 +00:00
"ve.ui.Toolbar",
Extend SurfaceToolbar into TargetToolbar Toolbars may want to control the target as well as the surface (spoiler alert!). The new TargetToolbar has a pointer to its target as well as its surface. Change-Id: I928316d9e23ac3f3de3e76c34ef0ac3d27855ab3
2013-09-06 00:10:06 +00:00
"ve.ui.TargetToolbar",
Window refactor Changes: * Cleanup the window API to use more consistent and intuitive methods - we now use initialize/setup/teardown instead of initialize/onSetup/onOpen/onClose as methods which are overridden, and use open/close methods to control the window * Change events around to have opening/open and closing/close events which act as before/after points during the opening/closing process * Make WindowSet and Context respond to windows being opened, rather than opening them directly * Fix a LinkInspector creation mode bug where the initial text doesn't get reset * Move inspector, a VisualEditor concept, back to VE * Cleanup naming of SurfaceDialog, SurfaceToolbar, etc. to use shorter names, they were given Surface* names when the generic ones were also in VE, but now the generic ones are in OO, so they can return to their original names Change-Id: I82c4fed8bcb3fb5630938c8bc4dd9b2d5f1a8c1d
2013-11-05 00:29:50 +00:00
"ve.ui.WindowSet",
ve.Editor Objectives: * Split ve.Surface into ve.Editor and ve.ui.Surface * Move actions, triggers and commands to ve.ui * Move toolbar wrapping, floating, shadow and actions functionality to configurable options of ve.ui.Toolbar * Make ve.ce.Surface and ve.ui.Surface inherit ve.Element and use this.$$ for iframe friendliness * Make the toolbar separately initialized so it's possible to have a surface without one, as well as control where the toolbar is Some change notes: VisualEditor.php * Added standalone module for mediawiki integrated unit testing ve.ce.Surface.js * Remove requirement to pass in an attached container to construct object * Inherit ve.Element and use this.$$ instead of $ * Make getSelectionRect iframe friendly * Move most of the initialize stuff to a new initialize method to be called after the surface is attached to the DOM ve.init.mw.ViewPageTarget.js * Merge toolbar functions into setup/teardown methods * Add toolbar manually (since it's not added by the surface anymore) ve.init.sa.Target.js * Update new init procedure for editor, surface and toolbar separately * Move toolbar floating stuff to ve.Toolbar Change-Id: If91a9d6e76a8be8d1b5a2566394765a37d29a8a7
2013-05-14 23:45:42 +00:00
"ve.ui.Action",
Detangle triggers from OOUI Changes: * Pass toolGroup into tools instead of toolbar * Split tool labels into title and accel * Make toolbars provide accelerator labels * Remove getLabelText method since it's not being used and is likely not useful * Make tools update their own labels * Only show accelerator information for triggers that are active in the surface * Make surface toolbars listen to commands being added and update tools accordingly * Introduce command object to encapsulate command info Change-Id: Ieac4bfa63b63ac0a9dee154af3007a33b4d447ff
2013-10-23 23:27:12 +00:00
"ve.ui.Trigger",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"ve.ui.Command",
"ve.ui.*Action",
"ve.ui.*Factory",
"ve.ui.*Registry",
"ve.ui.*Tool",
"ve.ui.*Inspector",
"ve.ui.*Widget",
"ve.ui.*Dialog"
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
]
},
ve.Editor Objectives: * Split ve.Surface into ve.Editor and ve.ui.Surface * Move actions, triggers and commands to ve.ui * Move toolbar wrapping, floating, shadow and actions functionality to configurable options of ve.ui.Toolbar * Make ve.ce.Surface and ve.ui.Surface inherit ve.Element and use this.$$ for iframe friendliness * Make the toolbar separately initialized so it's possible to have a surface without one, as well as control where the toolbar is Some change notes: VisualEditor.php * Added standalone module for mediawiki integrated unit testing ve.ce.Surface.js * Remove requirement to pass in an attached container to construct object * Inherit ve.Element and use this.$$ instead of $ * Make getSelectionRect iframe friendly * Move most of the initialize stuff to a new initialize method to be called after the surface is attached to the DOM ve.init.mw.ViewPageTarget.js * Merge toolbar functions into setup/teardown methods * Add toolbar manually (since it's not added by the surface anymore) ve.init.sa.Target.js * Update new init procedure for editor, surface and toolbar separately * Move toolbar floating stuff to ve.Toolbar Change-Id: If91a9d6e76a8be8d1b5a2566394765a37d29a8a7
2013-05-14 23:45:42 +00:00
{
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"name": "Tests",
Test Surface with IME-like event sequences * modules/ve/test/ce/ve.ce.TestRunner.js Class to interact with the CE Surface and document in tests * modules/ve/ve.EventSequencer.js Wrap setTimeout/clearTimeout calls (for easy replacement in tests) Change-Id: I2e2407e2b169ae77237c87bf8857b3026cc7efce
2013-10-17 11:20:53 +00:00
"classes": [
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"ve.QUnit",
"ve.QUnit.assert",
Test Surface with IME-like event sequences * modules/ve/test/ce/ve.ce.TestRunner.js Class to interact with the CE Surface and document in tests * modules/ve/ve.EventSequencer.js Wrap setTimeout/clearTimeout calls (for easy replacement in tests) Change-Id: I2e2407e2b169ae77237c87bf8857b3026cc7efce
2013-10-17 11:20:53 +00:00
"ve.ce.TestOffset",
"ve.ce.TestRunner"
]
}
]
},
UnicodeJS library to implement Unicode standards Initially just with a Wordbreak module to implement Unicode standard on 'Default Word Boundaries'. Due to it's standaloneability this has been written as a separate library. Non-BMP characters are currently not supported. Bug: 44085 Change-Id: Ieafa070076f4c36855684f6bc179667e28af2c25
2013-03-18 11:31:14 +00:00
{
"name": "UnicodeJS",
"groups": [
{
"name": "UnicodeJS",
"classes": [
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"unicodeJS",
"unicodeJS.TextString",
"unicodeJS.wordbreak",
"unicodeJS.graphemebreak"
UnicodeJS library to implement Unicode standards Initially just with a Wordbreak module to implement Unicode standard on 'Default Word Boundaries'. Due to it's standaloneability this has been written as a separate library. Non-BMP characters are currently not supported. Bug: 44085 Change-Id: Ieafa070076f4c36855684f6bc179667e28af2c25
2013-03-18 11:31:14 +00:00
]
}
]
},
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
{
"name": "OOJS UI",
"groups": [
{
"name": "General",
"classes": [
"OO.ui",
"OO.ui.Element",
"OO.ui.Frame",
"OO.ui.Toolbar",
"OO.ui.Window",
"OO.ui.WindowSet",
"OO.ui.Dialog"
]
},
{
"name": "Factories",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"OO.ui.*Factory"
]
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
},
{
"name": "Tools",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"OO.ui.*Tool"
]
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
},
{
"name": "Elements",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"OO.ui.*Element"
]
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
},
{
"name": "Layouts",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"OO.ui.*Layout"
]
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
},
{
"name": "Tool groups",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"OO.ui.*ToolGroup"
]
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
},
{
"name": "Widgets",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"OO.ui.*Widget"
]
Split oojs-ui from ve.ui * Move and rename generic parts of ve.ui to OO.ui * We now have a UI test suite because ve.Element (outside ve.ui) is now part of oojs-ui, so it needs a test suite. * Added to the MW test run (just like we do for unicodejs). * Updated csslint config (also added ve-mw and syntaxhighlight which were missing). oojs-ui still depends on the TriggerRegistry in VE, this is addressed in a follow-up commit. Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-09 20:09:59 +00:00
}
]
},
JSDuck: Fix warnings Warning: modules/ve/test/ve.qunit.js:5: Class QUnit not found Warning: .docs/categories.json No class found matching a pattern 've.Position' in categories file Warning: modules/ve/ce/ve.ce.Surface.js:1297: Unknown type MouseEvent Warning: modules/ve/ce/ve.ce.Surface.js:1297: Unknown type int Follows-up: * Ic21c9d3f * Ib521eaa6 Change-Id: I8e371a2d4d91a1f03bd4ef59d18b7df715f23238
2013-01-15 20:15:17 +00:00
{
"name": "Upstream",
"groups": [
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
{
"name": "OOJS",
"classes": [
"OO",
"OO.EventEmitter",
"OO.Factory",
"OO.Registry"
]
},
JSDuck: Fix warnings Warning: modules/ve/test/ve.qunit.js:5: Class QUnit not found Warning: .docs/categories.json No class found matching a pattern 've.Position' in categories file Warning: modules/ve/ce/ve.ce.Surface.js:1297: Unknown type MouseEvent Warning: modules/ve/ce/ve.ce.Surface.js:1297: Unknown type int Follows-up: * Ic21c9d3f * Ib521eaa6 Change-Id: I8e371a2d4d91a1f03bd4ef59d18b7df715f23238
2013-01-15 20:15:17 +00:00
{
"name": "jQuery",
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"classes": [
"jQuery",
"jQuery.Event",
"jQuery.Promise",
"jQuery.Deferred",
"jQuery.jqXHR",
"QUnit"
]
Fix JSDuck warnings Follows-up I44bcb79a59 and various other changes. Please remember to generate documentation and resolve all warnings before pushing into gerrit. Change-Id: I8a372443e841308463376d8673ce027a97bbcd30
2013-02-25 23:29:35 +00:00
},
{
"name": "JavaScript",
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
"classes": [
Use submodule for VisualEditor core * Add lib/ve. * Remove modules provided by VisualEditor core. * Update paths. * Remove VisualEditor core specific things from Gruntfile. * Remove entries from external.js already in lib/ve/.docs/external.js. * Implement build script to compose a jsduck index that includes all of VisualEditor core. Right now it includes VisualEditor's index as-is, and because those patterns (e.g. ve.dm.*Node) will also MW subclasses this means our category page will include MW classes under "VisualEditor (core)" (before the repo split, this was intentional). This is inevitable unless we list every class individually, or (the plan) until we move the MW subclasses out of the ve.* namespace and into mw.* somewhere. Bug: 45342 Change-Id: Iff45cd555430634c9fc341fd3b177c1e0625300b
2013-12-19 23:07:19 +00:00
"Array",
"Boolean",
"Date",
"Function",
"Number",
"Object",
"RegExp",
"String"
Layouts, grids and panels Layouts * Makes widget inherit from element * Adds layout which also inherits from element * Adds grid and panel layouts * Uses grid layout in meta dialog Other changes * Corrects issues with several of the stand-alone files by fixing and using makeStaticLoader.php Change-Id: I6b92c0204e176c914c26eff8c03ea417578e080c
2013-03-15 00:01:01 +00:00
]
JSDuck: Fix warnings Warning: modules/ve/test/ve.qunit.js:5: Class QUnit not found Warning: .docs/categories.json No class found matching a pattern 've.Position' in categories file Warning: modules/ve/ce/ve.ce.Surface.js:1297: Unknown type MouseEvent Warning: modules/ve/ce/ve.ce.Surface.js:1297: Unknown type int Follows-up: * Ic21c9d3f * Ib521eaa6 Change-Id: I8e371a2d4d91a1f03bd4ef59d18b7df715f23238
2013-01-15 20:15:17 +00:00
}
]
JSDuck: Generated code documentation! See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
}
Fix JSDuck warnings Follows-up I44bcb79a59 and various other changes. Please remember to generate documentation and resolve all warnings before pushing into gerrit. Change-Id: I8a372443e841308463376d8673ce027a97bbcd30
2013-02-25 23:29:35 +00:00
]
Reference in a new issue Copy permalink