Skip to content

Fix doc comments (no @ocaml.*) #6856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 5, 2024
Merged

Fix doc comments (no @ocaml.*) #6856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e13d5a
Check in changes after make lib
cknitt Jul 4, 2024
6689708
Fix doc comments (no @ocaml.*)
cknitt Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions jscomp/others/belt_HashSetInt.resi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */

/***
This module is [`Belt.HashSet`]() specialized with key type to be a primitive type.
This module is [`Belt.HashSet`]() specialized with key type to be a primitive type.

It is more efficient in general, the API is the same with [`Belt.HashSet`]() except its key type is fixed,
and identity is not needed(using the built-in one)
It is more efficient in general, the API is the same with [`Belt.HashSet`]() except its key type is fixed,
and identity is not needed(using the built-in one)

**See** [`Belt.HashSet`]()
**See** [`Belt.HashSet`]()
*/

type key = int
Expand Down
8 changes: 4 additions & 4 deletions jscomp/others/belt_HashSetString.resi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */

/***
This module is [`Belt.HashSet`]() specialized with key type to be a primitive type.
This module is [`Belt.HashSet`]() specialized with key type to be a primitive type.

It is more efficient in general, the API is the same with [`Belt.HashSet`]() except its key type is fixed,
and identity is not needed(using the built-in one)
It is more efficient in general, the API is the same with [`Belt.HashSet`]() except its key type is fixed,
and identity is not needed(using the built-in one)

**See** [`Belt.HashSet`]()
**See** [`Belt.HashSet`]()
*/

type key = string
Expand Down
136 changes: 66 additions & 70 deletions jscomp/others/js.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,15 @@
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */

@@config({flags: ["-unboxed-types", "-w", "-49"]})
@@ocaml.text(/* DESIGN:

/* DESIGN:
- It does not have any code, all its code will be inlined so that
there will never be
{[ require('js')]}
- Its interface should be minimal
*/

"
/***
The Js module mostly contains ReScript bindings to _standard JavaScript APIs_
like [console.log](https://developer.mozilla.org/en-US/docs/Web/API/Console/log),
or the JavaScript
Expand Down Expand Up @@ -71,9 +72,9 @@ Js.log(Js.String.startsWith(\"Re\", \"ReScript\"))
## Js.Xxx2 Modules

Prefer `Js.Array2` over `Js.Array`, `Js.String2` over `Js.String`, etc. The latters are old modules.
")
*/

@ocaml.doc(" JS object type ")
/** JS object type */
type t<'a> = {..} as 'a

module MapperRt = Js_mapperRt
Expand All @@ -86,24 +87,22 @@ module Internal = {
external opaque: 'a => 'a = "%opaque"
}

@@ocaml.text("/*")

@ocaml.doc("
/**
Nullable value of this type can be either null or 'a. This type is equivalent to Js.Null.t.
")
*/
@unboxed
type null<+'a> = Value('a) | @as(null) Null

@ocaml.doc("
/**
A value of this type can be either undefined or 'a. This type is equivalent to Js.Undefined.t.
")
*/
type undefined<+'a>

@unboxed type nullable<+'a> = Value('a) | @as(null) Null | @as(undefined) Undefined

@@ocaml.text("
/***
A value of this type can be undefined, null or 'a. This type is equivalent to Js.Null_undefined.t.
")
*/

type null_undefined<+'a> = nullable<'a>

Expand All @@ -113,177 +112,174 @@ external nullToOption: null<'a> => option<'a> = "#null_to_opt"
external isNullable: nullable<'a> => bool = "#is_nullable"
external import: 'a => promise<'a> = "#import"

@ocaml.doc(" The same as {!test} except that it is more permissive on the types of input ")
/** The same as {!test} except that it is more permissive on the types of input */
external testAny: 'a => bool = "#is_nullable"

@ocaml.doc("
/**
The promise type, defined here for interoperation across packages.
")
*/
type promise<+'a, +'e>

@ocaml.doc("
/**
The same as empty in `Js.Null`. Compiles to `null`.
")
*/
external null: null<'a> = "#null"

@ocaml.doc("
/**
The same as empty `Js.Undefined`. Compiles to `undefined`.
")
*/
external undefined: undefined<'a> = "#undefined"

@ocaml.doc("
/**
`typeof x` will be compiled as `typeof x` in JS. Please consider functions in
`Js.Types` for a type safe way of reflection.
")
*/
external typeof: 'a => string = "#typeof"

@val @scope("console") @ocaml.doc(" Equivalent to console.log any value. ")
@val @scope("console") /** Equivalent to console.log any value. */
external log: 'a => unit = "log"

@val @scope("console") external log2: ('a, 'b) => unit = "log"
@val @scope("console") external log3: ('a, 'b, 'c) => unit = "log"

@val @scope("console") external log4: ('a, 'b, 'c, 'd) => unit = "log"

@val
@scope("console")
@variadic
@ocaml.doc(" A convenience function to console.log more than 4 arguments ")
@val @scope("console") @variadic /** A convenience function to console.log more than 4 arguments */
external logMany: array<'a> => unit = "log"

external eqNull: ('a, null<'a>) => bool = "%bs_equal_null"
external eqUndefined: ('a, undefined<'a>) => bool = "%bs_equal_undefined"
external eqNullable: ('a, nullable<'a>) => bool = "%bs_equal_nullable"

@@ocaml.text(" ## Operators ")
/* ## Operators */

@ocaml.doc("
/**
`unsafe_lt(a, b)` will be compiled as `a < b`.
It is marked as unsafe, since it is impossible
to give a proper semantics for comparision which applies to any type
")
*/
external unsafe_lt: ('a, 'a) => bool = "#unsafe_lt"

@ocaml.doc("
/**
`unsafe_le(a, b)` will be compiled as `a <= b`.
See also `Js.unsafe_lt`.
")
*/
external unsafe_le: ('a, 'a) => bool = "#unsafe_le"

@ocaml.doc("
/**
`unsafe_gt(a, b)` will be compiled as `a > b`.
See also `Js.unsafe_lt`.
")
*/
external unsafe_gt: ('a, 'a) => bool = "#unsafe_gt"

@ocaml.doc("
/**
`unsafe_ge(a, b)` will be compiled as `a >= b`.
See also `Js.unsafe_lt`.
")
*/
external unsafe_ge: ('a, 'a) => bool = "#unsafe_ge"

@@ocaml.text(" ## Nested Modules ")
/* ## Nested Modules */

@ocaml.doc(" Provide utilities for `Js.null<'a>` ")
/** Provide utilities for `Js.null<'a>` */
module Null = Js_null

@ocaml.doc(" Provide utilities for `Js.undefined<'a>` ")
/** Provide utilities for `Js.undefined<'a>` */
module Undefined = Js_undefined

@ocaml.doc(" Provide utilities for `Js.null_undefined` ")
/** Provide utilities for `Js.null_undefined` */
module Nullable = Js_null_undefined

module Null_undefined = Js_null_undefined

@ocaml.doc(" Provide utilities for dealing with Js exceptions ")
/** Provide utilities for dealing with Js exceptions */
module Exn = Js_exn

@ocaml.doc(" Provide bindings to JS array")
/** Provide bindings to JS array*/
module Array = Js_array

@ocaml.doc(" Provide bindings to JS array")
/** Provide bindings to JS array*/
module Array2 = Js_array2

@ocaml.doc(" Provide bindings to JS string ")
/** Provide bindings to JS string */
module String = Js_string

@ocaml.doc(" Provide bindings to JS string ")
/** Provide bindings to JS string */
module String2 = Js_string2

@ocaml.doc(" Provide bindings to JS regex expression ")
/** Provide bindings to JS regex expression */
module Re = Js_re

@ocaml.doc(" Provide bindings to JS Promise ")
/** Provide bindings to JS Promise */
module Promise = Js_promise

@ocaml.doc(" Provide bindings to JS Promise ")
/** Provide bindings to JS Promise */
module Promise2 = Js_promise2

@ocaml.doc(" Provide bindings for JS Date ")
/** Provide bindings for JS Date */
module Date = Js_date

@ocaml.doc(" Provide utilities for JS dictionary object ")
/** Provide utilities for JS dictionary object */
module Dict = Js_dict

@ocaml.doc(" Provide bindings to JS global functions in global namespace")
/** Provide bindings to JS global functions in global namespace*/
module Global = Js_global

@ocaml.doc(" Provide utilities for json ")
/** Provide utilities for json */
module Json = Js_json

@ocaml.doc(" Provide bindings for JS `Math` object ")
/** Provide bindings for JS `Math` object */
module Math = Js_math

@ocaml.doc(" Provide utilities for `Js.t` ")
/** Provide utilities for `Js.t` */
module Obj = Js_obj

@ocaml.doc(" Provide bindings for JS typed array ")
/** Provide bindings for JS typed array */
module Typed_array = Js_typed_array

@ocaml.doc(" Provide bindings for JS typed array ")
/** Provide bindings for JS typed array */
module TypedArray2 = Js_typed_array2

@ocaml.doc(" Provide utilities for manipulating JS types ")
/** Provide utilities for manipulating JS types */
module Types = Js_types

@ocaml.doc(" Provide utilities for JS float ")
/** Provide utilities for JS float */
module Float = Js_float

@ocaml.doc(" Provide utilities for int ")
/** Provide utilities for int */
module Int = Js_int

@ocaml.doc(" Provide utilities for bigint ")
/** Provide utilities for bigint */
module BigInt = Js_bigint

@ocaml.doc(" Provide utilities for File ")
/** Provide utilities for File */
module File = Js_file

@ocaml.doc(" Provide utilities for Blob ")
/** Provide utilities for Blob */
module Blob = Js_blob

@ocaml.doc(" Provide utilities for option ")
/** Provide utilities for option */
module Option = Js_option

@ocaml.doc(" Define the interface for result ")
/** Define the interface for result */
module Result = Js_result

@ocaml.doc(" Provide utilities for list ")
/** Provide utilities for list */
module List = Js_list

@ocaml.doc(" Provides bindings for JS Vector ")
/** Provides bindings for JS Vector */
module Vector = Js_vector

@ocaml.doc(" Provides bindings for console ")
/** Provides bindings for console */
module Console = Js_console

@ocaml.doc(" Provides bindings for ES6 Set ")
/** Provides bindings for ES6 Set */
module Set = Js_set

@ocaml.doc(" Provides bindings for ES6 WeakSet ")
/** Provides bindings for ES6 WeakSet */
module WeakSet = Js_weakset

@ocaml.doc(" Provides bindings for ES6 Map ")
/** Provides bindings for ES6 Map */
module Map = Js_map

@ocaml.doc(" Provides bindings for ES6 WeakMap ")
/** Provides bindings for ES6 WeakMap */
module WeakMap = Js_weakmap
Loading