aboutsummaryrefslogtreecommitdiffstats
path: root/jsdoc.js
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Add documentation for several trivial modulesJon Robson2024-01-171-7/+0
| | | | | Bug: T352308 Change-Id: Ib4c27c843362e61f6fd9854f78d7acac213719f3
* Documentation: Move to exclude listJon Robson2024-01-161-68/+1
| | | | | | | | | * 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
* Update links to OOUI documentationBartosz Dziewoński2024-01-131-14/+14
| | | | | | | | | 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
* Documentation: mw.widgetJon Robson2024-01-091-2/+15
| | | | | | | | | * 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
* Document jQuery pluginsJon Robson2024-01-081-3/+3
| | | | | Bug: T352308 Change-Id: Id3a0ec3d71e4e2966baf46f43652001c3b00674a
* Document mw.FeedbackJon Robson2024-01-081-1/+2
| | | | | Bug: T352308 Change-Id: Ic76c51d43f8bccad9d10bae1078d2f94b221bebe
* Document mediawiki.templateJon Robson2024-01-031-2/+2
| | | | | Bug: T352308 Change-Id: I6164c06cad08683295b7af138519979bf058b959
* Merge "Documentation: Document mediawiki.page.ready"jenkins-bot2024-01-031-1/+3
|\
| * Documentation: Document mediawiki.page.readyJon Robson2023-12-221-1/+3
| | | | | | | | | | Bug: T352308 Change-Id: I1947d923a20aff08fabec486dc82b740b12a0e4a
* | mediawiki.page.watch.ajax: document moduleMusikAnimal2023-12-221-1/+1
|/ | | | | | | | | Changes: * Marked public methods as @stable, marked all others as @private * Fix indentation of example in util.js Bug: T352308 Change-Id: I051773b87c3009141ded67d506c1fd683bbb1f60
* documentation: Convert mw.Upload and mw.ForeignUpload to jsdocRoan Kattouw2023-12-201-2/+2
| | | | | Bug: T352308 Change-Id: I857307b9856a56094600c8fc4d9ffcc825c11f80
* Merge "mediawiki.page.preview: document module in JSDoc"jenkins-bot2023-12-191-1/+1
|\
| * mediawiki.page.preview: document module in JSDocMusikAnimal2023-12-181-1/+1
| | | | | | | | | | Bug: T352308 Change-Id: I2d9558a6a4741fd2348fb79890cc9a5c32f3afb0
* | mediawiki.storage: Document in jsdocJon Robson2023-12-191-1/+1
| | | | | | | | | | Bug: T352308 Change-Id: I1b1818ea10159e1f27d7f4f16a20484e6aefa3c1
* | documentation: Convert mediawiki.api from jsduck to jsdocRoan Kattouw2023-12-191-1/+2
|/ | | | | Bug: T352308 Change-Id: Ia9320213e2208bb45a7f162b5b5c385fbed09599
* Documentation: Port mw.user to JSDoclwatson2023-12-181-1/+1
| | | | | Bug: T352308 Change-Id: I3b9d3f6409d5a6ea09d3e4aefb773844e99508a4
* Merge "Documentation: Port mw.Uri to JSDoc"jenkins-bot2023-12-161-2/+3
|\
| * Documentation: Port mw.Uri to JSDoclwatson2023-12-151-2/+3
| | | | | | | | | | Bug: T352308 Change-Id: If780d42c77ac270046ac19a534c758ef2e6f7215
* | Cookie: Document in jsdocJon Robson2023-12-151-1/+1
| | | | | | | | | | | | | | | | | | | | 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
* | mw.Title: Document in jsdocJon Robson2023-12-141-0/+1
|/ | | | | Bug: T352308 Change-Id: I5db0fd4fef027a4d97953079a69c14f64f835f68
* mediawiki:string: Document moduleJon Robson2023-12-131-2/+1
| | | | | | | | | | Changes: * Addresses eslint warnings relating to multiple @return types * Adopt ES6 shorthand function for return values Bug: T352308 Change-Id: I43cb7e8e5f8c9ded46249e5f26a60a314b7d8cb1
* Merge "Documentation: Migrate jQuery lengthLimit plugin to JSDoc"jenkins-bot2023-12-131-2/+2
|\
| * Documentation: Migrate jQuery lengthLimit plugin to JSDocAnne Tomasevich2023-12-131-2/+2
| | | | | | | | | | Bug: T352308 Change-Id: Ie415603420b818bb3aa20215965d488b538a0931
* | Documentation: Migrate mw.experiments docs to JSDocAnne Tomasevich2023-12-131-1/+1
|/ | | | | Bug: T352308 Change-Id: I3bccaab232647f2c368758bd6c7e395d9b009bae
* jsdoc: Use the summarize pluginRoan Kattouw2023-12-071-1/+2
| | | | | Bug: T344861 Change-Id: I699cd2a5584e78065594d6debbb6f2a2e6d1f7c4
* Documentation: Expand the documentation in jsdocJon Robson2023-12-071-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Add jsdoc with jsdoc-wmf-themeJon Robson2023-11-281-0/+145
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
generated by cgit v1.2.3 (git 2.25.1) at 2025-04-26 05:47:40 +0000