Commit graph

9 commits

Author SHA1 Message Date
Thiemo Kreuz c2017f74b2 Remove @param/@return docs that literally repeat the code
These don't add any knowledge but make the code harder to read
and maintain, and are an additional source of errors.

Change-Id: Ied57741a3f985e355adfddb4e75378d5c497faa9
2021-06-14 15:44:51 +02:00
James D. Forrester 2c77e88d2c doc: Bump copyright year for 2020
Change-Id: I30539877543dc2a57bd1428a00d10ac46d8fc294
2020-01-08 09:13:24 -08:00
Bartosz Dziewoński 84d548e7b1 Remove redundant @method annotations
A @method annotation is only necessary when the docblock is not
directly followed by a function declaration (in which case JSDuck
assumes it documents a property), e.g. when defining an abstract
function or referencing a function from another library.

I verified that JSDuck generates exactly the same output before and
after this change (docs/data-<hash>.js files are identical).

Change-Id: I7edf51a8560ab9978b42800ab1026f0b5555c3bf
2019-08-21 23:33:15 +02:00
James D. Forrester 3c293ea00c doc: Bump copyright year for 2019
Change-Id: I8991b97c980d4149f53eb5601036220ef3c0c440
2019-01-01 13:24:23 +00:00
Bartosz Dziewoński 0f05dafa6f Make SaveErrorHandler receive entire API response
Previously we passed either data.visualeditoredit.edit or data.error,
which was mostly okay since they are mutually exclusive, but it could
still theoretically conflict if both objects had identical properties
(and receiving different things could make debugging errors harder).

Change-Id: I818d916275b8451af6910ddaa7cd4d7c653085ee
2018-12-07 14:17:16 -05:00
Ed Sanders be548979fe Pass error data to SaveErrorHandler on error
Change-Id: I9d7efbecfd954acff86f279f75aa80a9fcc10c89
2018-12-06 14:59:30 -05:00
Bartosz Dziewoński 9177974c28 ve.init.mw.SaveErrorHandler: Correct code comments
Change-Id: I6e3a883b8c2600953da038aa4ad3601258e1d87d
2018-12-05 16:37:13 -05:00
Ed Sanders 1ee9a739a1 Move ve.init.mw.saveErrorHandlerFactory and fix documentation
Change-Id: Icc8a4d1daf17a1a4cd0d7b2ad97f61916f2a222e
2018-12-04 17:55:35 -05:00
Ed Sanders 041e7b77a1 Create SaveErrorHandler class to better define structure
Change-Id: I036ee32847cc3b25a1cc478247cfe54599781098
2018-11-29 15:47:03 +00:00