* Generate documentation for all files in resources/src
* Include all files documented in phase 3 as not having public APIs. Add
@ignore tag to documentation that shows up in published document.
Bug: T352308
Change-Id: I5d643d815ffa2f578d12bb9ca70e26558a442c32
OOUI uses JSDoc now (T185396). Update links from the JSDuck format.
Remove an unnecessary @see that was pointing to a private method with
no documentation.
Change-Id: I26b0f0d586f4ba23974cadd34662d3ffc7f8ccba
* Add to documentations
* Add full stops to sentences in summaries where missing
* Correct a few instances of "set" with "get"
Bug: T352308
Change-Id: I6cb00167041d6e0936730eea298daf4fc2e485b5
Changes:
* Marked public methods as @stable, marked all others as @private
* Fix indentation of example in util.js
Bug: T352308
Change-Id: I051773b87c3009141ded67d506c1fd683bbb1f60
Changes:
* Switch from mixed to string|null since cookies always cast
to a string. For example `mw.cookie.set('foo',6)` results in '6'
and `mw.cookie.set('foo',[1,2,3])` results in '1,2,3'.
Bug: T35230
Change-Id: I4a27abe6b430fef75506df129f3168dcc4bbd565
Significant changes:
* The Notification class was marked as private but is returned
by a public mw.notify function so presumably is a public interface
so is no longer marked as @private
* I've documented the mw object under namespaces and reserved the
class section for types that are referenced within that documentation.
* mw.loader methods used by ResourceLoader but not intended as public
APIs are marked as public after talking to Roan. This can be modified
later if necessary.
* Remove jsduck eslint plugin from startup module
Notes about organization:
* ResourceLoader Modules are documented under modules. After discussing
with Roan, Anne and Alex this makes sense for now. We can pivot at the end
of the project if needed. MediaWiki util module acts as an example for modules
that also appear on the global mw object
* We use namespaces for libraries on the mw global
* Global methods are documented on the Window namespace
* All hooks are documented under the mw.hook namespace given the namespace
provided important information for how to use them.
Bug: T352308
Change-Id: Ia709de48cbc0f00ff832eb4666e6abcffdb6f710
jsduck is preventing us from using ES6 syntax and has not
been supported for some time. It is also difficult to setup
locally due its use of Ruby.
Introduce jsdoc and remove jsduck per T138401#9335987
Link to static copy of jsduck explaining the state
This does the bare minimum - the docs are built to the folder
docs/js/index.html and only one module is ported over to allow
us to provide feedback on the end result.
Bug: T138401
Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
