Skip to content

Commit bcafcc6

Browse files
authored
Merge pull request #554 from scala-js/issue/553
Remove MDN from scaladocs
2 parents da70c22 + d8f779a commit bcafcc6

33 files changed

+30
-3802
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Documentation marked "MDN" is thanks to Mozilla Contributors
1+
All documentation for facades is thanks to Mozilla Contributors
22
at https://developer.mozilla.org/en-US/docs/Web/API and available
33
under the Creative Commons Attribution-ShareAlike v2.5 or later.
44
http://creativecommons.org/licenses/by-sa/2.5/

src/main/scala/org/scalajs/dom/AbortController.scala

-12
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,33 @@ import scala.scalajs.js.annotation.JSGlobal
55

66
/** The AbortController interface represents a controller object that allows you to abort one or more DOM requests as
77
* and when desired.
8-
*
9-
* MDN
108
*/
119
@js.native
1210
@JSGlobal
1311
class AbortController() extends js.Object {
1412

1513
/** Returns a AbortSignal object instance, which can be used to communicate with/abort a DOM request
16-
*
17-
* MDN
1814
*/
1915
val signal: AbortSignal = js.native
2016

2117
/** Aborts a DOM request before it has completed. This is able to abort fetch requests, consumption of any response
2218
* Body, and streams.
23-
*
24-
* MDN
2519
*/
2620
def abort(): Unit = js.native
2721
}
2822

2923
/** The AbortSignal interface represents a signal object that allows you to communicate with a DOM request (such as a
3024
* Fetch) and abort it if required via an AbortController object.
31-
*
32-
* MDN
3325
*/
3426
@js.native
3527
trait AbortSignal extends EventTarget {
3628

3729
/** A Boolean that indicates whether the request(s) the signal is communicating with is/are aborted (true) or not
3830
* (false).
39-
*
40-
* MDN
4131
*/
4232
def aborted: Boolean = js.native
4333

4434
/** Invoked when an abort event fires, i.e. when the DOM request(s) the signal is communicating with is/are aborted.
45-
*
46-
* MDN
4735
*/
4836
var onabort: js.Function0[Any] = js.native
4937
}

src/main/scala/org/scalajs/dom/CSSTypes.scala

+2-68
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
/** Documentation marked "MDN" is thanks to Mozilla Contributors at https://developer.mozilla.org/en-US/docs/Web/API and
2-
* available under the Creative Commons Attribution-ShareAlike v2.5 or later.
1+
/** All documentation for facades is thanks to Mozilla Contributors at https://developer.mozilla.org/en-US/docs/Web/API
2+
* and available under the Creative Commons Attribution-ShareAlike v2.5 or later.
33
* http://creativecommons.org/licenses/by-sa/2.5/
44
*
55
* Everything else is under the MIT License http://opensource.org/licenses/MIT
@@ -15,24 +15,18 @@ object CSS extends js.Object {
1515

1616
/** The CSS.supports() method returns a boolean value indicating if the browser supports a given CSS feature, or not.
1717
* Allows to test the support of a pair property-value.
18-
*
19-
* MDN
2018
*/
2119
def supports(propertyName: String, value: String): Boolean = js.native
2220

2321
/** The CSS.supports() method returns a boolean value indicating if the browser supports a given CSS feature, or not.
2422
* Takes one parameter matching the condition of @supports.
25-
*
26-
* MDN
2723
*/
2824
def supports(supportCondition: String): Boolean = js.native
2925

3026
}
3127

3228
/** A CSSStyleDeclaration is an interface to the declaration block returned by the style property of a cssRule in a
3329
* stylesheet, when the rule is a CSSStyleRule.
34-
*
35-
* MDN
3630
*/
3731
@js.native
3832
@JSGlobal
@@ -247,8 +241,6 @@ class CSSStyleDeclaration extends js.Object {
247241
}
248242

249243
/** An object implementing the CSSStyleSheet interface represents a single CSS style sheet.
250-
*
251-
* MDN
252244
*/
253245
@js.native
254246
@JSGlobal
@@ -262,14 +254,10 @@ class CSSStyleSheet extends StyleSheet {
262254

263255
/** If this style sheet is imported into the document using an `@import` rule, the ownerRule property will return that
264256
* CSSImportRule, otherwise it returns null.
265-
*
266-
* MDN
267257
*/
268258
var ownerRule: CSSRule = js.native
269259

270260
/** Returns a CSSRuleList of the CSS rules in the style sheet.
271-
*
272-
* MDN
273261
*/
274262
var cssRules: CSSRuleList = js.native
275263
var id: String = js.native
@@ -279,16 +267,12 @@ class CSSStyleSheet extends StyleSheet {
279267
def addPageRule(bstrSelector: String, bstrStyle: String, lIndex: Int = js.native): Int = js.native
280268

281269
/** The CSSStyleSheet.insertRule() method inserts a new style rule into the current style sheet.
282-
*
283-
* MDN
284270
*/
285271
def insertRule(rule: String, index: Int = js.native): Int = js.native
286272

287273
def removeRule(lIndex: Int): Unit = js.native
288274

289275
/** Deletes a rule from the style sheet.
290-
*
291-
* MDN
292276
*/
293277
def deleteRule(index: Int = js.native): Unit = js.native
294278

@@ -299,39 +283,29 @@ class CSSStyleSheet extends StyleSheet {
299283

300284
/** CSSStyleRule represents a single CSS style rule. It implements the CSSRule interface with a type value of 1
301285
* (CSSRule.STYLE_RULE).
302-
*
303-
* MDN
304286
*/
305287
@js.native
306288
@JSGlobal
307289
class CSSStyleRule extends CSSRule {
308290

309291
/** Gets/sets the textual representation of the selector for this rule, e.g. "h1,h2".
310-
*
311-
* MDN
312292
*/
313293
var selectorText: String = js.native
314294
var readOnly: Boolean = js.native
315295

316296
/** Returns the CSSStyleDeclaration object for the rule.
317-
*
318-
* MDN
319297
*/
320298
val style: CSSStyleDeclaration = js.native
321299
}
322300

323301
/** CSSMediaRule is an object representing a single CSS `@media` rule. It implements the CSSConditionRule interface, and
324302
* therefore the CSSGroupingRule and the CSSRule interface with a type value of 4 (CSSRule.MEDIA_RULE).
325-
*
326-
* MDN
327303
*/
328304
@js.native
329305
@JSGlobal
330306
class CSSMediaRule extends CSSRule {
331307

332308
/** Specifies a MediaList representing the intended destination medium for style information.
333-
*
334-
* MDN
335309
*/
336310
var media: MediaList = js.native
337311
var cssRules: CSSRuleList = js.native
@@ -343,23 +317,17 @@ class CSSMediaRule extends CSSRule {
343317

344318
/** The CSSNamespaceRule interface describes an object representing a single CSS `@@namespace` at-rule. It implements
345319
* the CSSRule interface, with a type value of 10 (CSSRule.NAMESPACE_RULE).
346-
*
347-
* MDN
348320
*/
349321
@js.native
350322
@JSGlobal
351323
class CSSNamespaceRule extends CSSRule {
352324

353325
/** Returns a DOMString containing the text of the URI of the given namespace.
354-
*
355-
* MDN
356326
*/
357327
var namespaceURI: String = js.native
358328

359329
/** Returns a DOMString with the name of the prefix associated to this namespace. If there is no such prefix, returns 
360330
* null.
361-
*
362-
* MDN
363331
*/
364332
var prefix: String = js.native
365333
}
@@ -374,30 +342,22 @@ class CSSImportRule extends CSSRule {
374342

375343
/** An object implementing the CSSRule DOM interface represents a single CSS at-rule. References to a
376344
* CSSRule-implementing object may be obtained by looking at a CSS style sheet's cssRules list.
377-
*
378-
* MDN
379345
*/
380346
@js.native
381347
@JSGlobal
382348
class CSSRule extends js.Object {
383349

384350
/** cssText returns the actual text of the style rule. To be able to set a stylesheet rule dynamically, see Using
385351
* dynamic styling information.
386-
*
387-
* MDN
388352
*/
389353
var cssText: String = js.native
390354

391355
/** parentStyleSheet returns the stylesheet object in which the current rule is defined.
392-
*
393-
* MDN
394356
*/
395357
var parentStyleSheet: CSSStyleSheet = js.native
396358

397359
/** Returns the containing rule, otherwise null. E.g. if this rule is a style rule inside an `@media` block, the
398360
* parent rule would be that CSSMediaRule.
399-
*
400-
* MDN
401361
*/
402362
var parentRule: CSSRule = js.native
403363
var `type`: Int = js.native
@@ -435,31 +395,23 @@ class CSSFontFaceRule extends CSSRule {
435395

436396
/** CSSPageRule is an object representing a single CSS `@page` rule. It implements the CSSRule interface with a type
437397
* value of 6 (CSSRule.PAGE_RULE).
438-
*
439-
* MDN
440398
*/
441399
@js.native
442400
@JSGlobal
443401
class CSSPageRule extends CSSRule {
444402
var pseudoClass: String = js.native
445403

446404
/** Represents the text of the page selector associated with the at-rule.
447-
*
448-
* MDN
449405
*/
450406
var selectorText: String = js.native
451407
var selector: String = js.native
452408

453409
/** Returns the declaration block associated with the at-rule.
454-
*
455-
* MDN
456410
*/
457411
var style: CSSStyleDeclaration = js.native
458412
}
459413

460414
/** A CSSRuleList is an array-like object containing an ordered collection of CSSRule objects.
461-
*
462-
* MDN
463415
*/
464416
@js.native
465417
@JSGlobal
@@ -470,68 +422,50 @@ class CSSRuleList private[this] () extends DOMList[CSSRule] {
470422
/** The CSSKeyframesRule interface describes an object representing a complete set of keyframes for a CSS animation. It
471423
* corresponds to the contains of a whole `@@keyframes` at-rule. It implements the CSSRule interface with a type value
472424
* of 7 (CSSRule.KEYFRAMES_RULE).
473-
*
474-
* MDN
475425
*/
476426
@js.native
477427
@JSGlobal
478428
class CSSKeyframesRule extends CSSRule {
479429

480430
/** Represents the name of the animation, used by the animation-name property.
481-
*
482-
* MDN
483431
*/
484432
var name: String = js.native
485433

486434
/** Returns a CSSRuleList of the CSS rules in the media rule.
487-
*
488-
* MDN
489435
*/
490436
var cssRules: CSSRuleList = js.native
491437

492438
/** Returns a keyframe rule corresponding to the given key. The key is a DOMString containing an index of the keyframe
493439
* o be returned, resolving to a number between 0 and 1. If no such keyframe exists, findRule returns null.
494-
*
495-
* MDN
496440
*/
497441
def findRule(rule: String): CSSKeyframeRule = js.native
498442

499443
/** Deletes a keyframe rule from the current CSSKeyframesRule. The parameter is the index of the keyframe to be
500444
* deleted, expressed as a DOMString resolving as a number between 0 and 1.
501-
*
502-
* MDN
503445
*/
504446
def deleteRule(rule: String): Unit = js.native
505447

506448
/** Inserts a new keyframe rule into the current CSSKeyframesRule. The parameter is a DOMString containing a keyframe
507449
* in the same format as an entry of a `@keyframes` at-rule. If it contains more than one keyframe rule, a
508450
* DOMException with a SYNTAX_ERR is thrown.
509-
*
510-
* MDN
511451
*/
512452
def appendRule(rule: String): Unit = js.native
513453
}
514454

515455
/** The CSSKeyframeRule interface describes an object representing a set of style for a given keyframe. It corresponds
516456
* to the contains of a single keyframe of a `@@keyframes` at-rule. It implements the CSSRule interface with a type
517457
* value of 8 (CSSRule.KEYFRAME_RULE).
518-
*
519-
* MDN
520458
*/
521459
@js.native
522460
@JSGlobal
523461
class CSSKeyframeRule extends CSSRule {
524462

525463
/** Represents the key of the keyframe, like '10%', '75%'. The from keyword maps to '0%' and the to keyword maps to
526464
* '100%'.
527-
*
528-
* MDN
529465
*/
530466
var keyText: String = js.native
531467

532468
/** Returns a CSSStyleDeclaration of the CSS style associated with the keyfrom.
533-
*
534-
* MDN
535469
*/
536470
var style: CSSStyleDeclaration = js.native
537471
}

src/main/scala/org/scalajs/dom/Fetch.scala

+5-7
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ object Fetch extends js.Object {
1717
def fetch(info: RequestInfo, init: RequestInit = null): js.Promise[Response] = js.native
1818
}
1919

20-
/** The Request interface of the Fetch API represents a resource request. MDN
20+
/** The Request interface of the Fetch API represents a resource request.
2121
*
2222
* see [[https://fetch.spec.whatwg.org/#request-class ¶6.3 Request Class]] in whatwg spec
2323
*
@@ -173,12 +173,12 @@ trait ResponseInit extends js.Object {
173173
@js.native
174174
trait Body extends js.Object {
175175

176-
/** MDN: Contains a Boolean that indicates whether the body has been read.
177-
*/
176+
/* Contains a Boolean that indicates whether the body has been read.
177+
*/
178178
def bodyUsed: Boolean = js.native
179179

180-
/** MDN: Takes a Response stream and reads it to completion. It returns a promise that resolves with an ArrayBuffer.
181-
*/
180+
/* Takes a Response stream and reads it to completion. It returns a promise that resolves with an ArrayBuffer.
181+
*/
182182
def arrayBuffer(): js.Promise[ArrayBuffer] = js.native
183183

184184
/** Takes a Response stream and reads it to completion. It returns a promise that resolves with a Blob.
@@ -216,8 +216,6 @@ trait Body extends js.Object {
216216
*
217217
* You can retrieve a Headers object via the Request.headers and Response.headers properties, and create a new Headers
218218
* object using the Headers.Headers() constructor.
219-
*
220-
* MDN
221219
*/
222220
@js.native
223221
@JSGlobal

0 commit comments

Comments
 (0)