Skip to content

Commit 253ba95

Browse files
Convert @ocaml.doc attributes back to /** */
1 parent 6ba6e48 commit 253ba95

10 files changed

+22
-24
lines changed

Diff for: src/Webapi.res

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
module Base64 = Webapi__Base64
22

3-
@ocaml.doc(" @since 0.18.0 ")
3+
/** @since 0.18.0 */
44
module Blob = Webapi__Blob
55
module Canvas = Webapi__Canvas
66
module Dom = Webapi__Dom
77
module File = Webapi__File
88

9-
@ocaml.doc(" Re-export from [bs-fetch] for convenience. To use, you will also
9+
/** Re-export from [bs-fetch] for convenience. To use, you will also
1010
need to add the [bs-fetch] package as a dependency.
1111
1212
To get the [FormData] of an HTML form, use
1313
[Webapi.Dom.HtmlFormElement.data].
1414
15-
@since 0.18.0 ")
15+
@since 0.18.0 */
1616
module FormData = Fetch.FormData
1717

18-
@ocaml.doc(" Re-export from [bs-fetch] for convenience. See also
18+
/** Re-export from [bs-fetch] for convenience. See also
1919
{!module:FormData}.
2020
21-
@since 0.18.0 ")
21+
@since 0.18.0 */
2222
module Iterator = FormData.Iterator
2323

2424
module Performance = Webapi__Performance
2525

26-
@ocaml.doc(" @since 0.19.0 ")
26+
/** @since 0.19.0 */
2727
module ReadableStream = Webapi__ReadableStream
2828

2929
module ResizeObserver = Webapi__ResizeObserver

Diff for: src/Webapi/Dom/Webapi__Dom__Document.res

+6-8
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module Impl = (
1919
}
2020
`)
2121

22-
@ocaml.doc(" Unsafe cast, use [ashtmlDocument] instead ")
22+
/** Unsafe cast, use [ashtmlDocument] instead */
2323
external unsafeAsHtmlDocument: T.t => Dom.htmlDocument = "%identity"
2424

2525
let ofNode = (node: Dom.node): option<T.t> =>
@@ -116,13 +116,11 @@ module Impl = (
116116
external registerElementWithOptions: (T.t, string, {..}, unit) => Dom.element =
117117
"registerElement" /* experimental and deprecated in favor of customElements.define() */
118118

119-
@@ocaml.doc(
120-
" XPath stuff "
121-
/* createExpression */
122-
/* createNSResolver */
123-
/* evaluate */
124-
/* GlobalEventHandlers interface */
125-
)
119+
/** XPath stuff */
120+
/* createExpression */
121+
/* createNSResolver */
122+
/* evaluate */
123+
/* GlobalEventHandlers interface */
126124
}
127125

128126
type t = Dom.document

Diff for: src/Webapi/Dom/Webapi__Dom__Element.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ module Impl = (
2525
}
2626
`)
2727

28-
@ocaml.doc(" Unsafe cast, use [asHtmlElement] instead ")
28+
/** Unsafe cast, use [asHtmlElement] instead */
2929
external unsafeAsHtmlElement: T.t => Dom.htmlElement = "%identity"
3030

3131
let ofNode: Dom.node => option<T.t> = ofNode

Diff for: src/Webapi/Dom/Webapi__Dom__EventTarget.res

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ module Impl = (
3333
) => unit = "removeEventListener"
3434
@send external dispatchEvent: (T.t, Dom.event_like<'a>) => bool = ""
3535

36-
@ocaml.doc("
37-
* non-standard event-specific functions
38-
")
36+
/**
37+
* non-standard event-specific functions
38+
*/
3939
@send
4040
external /* UI */
4141
addLoadEventListener: (T.t, @as("load") _, Dom.event => unit) => unit = "addEventListener"

Diff for: src/Webapi/Dom/Webapi__Dom__HtmlFormElement.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ module Impl = (
3636
@send external checkValidity: t_htmlFormElement => bool = ""
3737
@send external reportValidity: t_htmlFormElement => bool = ""
3838

39-
@ocaml.doc(" @since 0.18.0 ") @new external data: T.t => Fetch.FormData.t = "FormData"
39+
/** @since 0.18.0 */ @new external data: T.t => Fetch.FormData.t = "FormData"
4040
}
4141

4242
type t = Dom.htmlFormElement

Diff for: src/Webapi/Dom/Webapi__Dom__Node.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ module Impl = (
5757
@send external normalize: T.t => unit = ""
5858
@send external removeChild: (T.t, Dom.node_like<'a>) => Dom.node_like<'a> = ""
5959

60-
@ocaml.doc(" @since 0.19.0 ") @send
60+
/** @since 0.19.0 */ @send
6161
external replaceChild: (T.t, Dom.node_like<'a>, Dom.node_like<'b>) => Dom.node_like<'b> = ""
6262
}
6363

Diff for: src/Webapi/Dom/Webapi__Dom__Types.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ let decodeDir = x =>
122122
| _ => Unknown
123123
}
124124

125-
@ocaml.doc(" @since 0.17.1 ")
125+
/** @since 0.17.1 */
126126
module EventPhase = {
127127
type t =
128128
| None

Diff for: src/Webapi/Webapi__Blob.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ module Impl = (
99

1010
@send external slice: (T.t, ~start: int=?, ~end_: int=?, ~contentType: string=?, unit) => T.t = ""
1111

12-
@ocaml.doc(" @since 0.19.0 ") @send external stream: T.t => Webapi__ReadableStream.t = ""
12+
/** @since 0.19.0 */ @send external stream: T.t => Webapi__ReadableStream.t = ""
1313

1414
@send external text: T.t => Js.Promise.t<string> = ""
1515

Diff for: src/Webapi/Webapi__File.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include Webapi__Blob.Impl({
88

99
@@text("{1 File class}")
1010

11-
@ocaml.doc(" @since 0.18.0 ") @get external lastModified: t => float = ""
11+
/** @since 0.18.0 */ @get external lastModified: t => float = ""
1212

1313
// [@new] external make: ... = "File";
1414

Diff for: src/Webapi/Webapi__Url.res

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type t
2222

2323
@new external make: string => t = "URL"
2424

25-
@ocaml.doc(" @since 0.19.0 ") @new external makeWith: (string, ~base: string) => t = "URL"
25+
/** @since 0.19.0 */ @new external makeWith: (string, ~base: string) => t = "URL"
2626

2727
@get external hash: t => string = ""
2828
@set external setHash: (t, string) => unit = "hash"

0 commit comments

Comments
 (0)