Skip to content

Commit d4c45b4

Browse files
Improve doc comment style
1 parent 4110f7f commit d4c45b4

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Sources/_CJavaScriptKit/include/_CJavaScriptKit.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ extern void _set_prop(const JavaScriptObjectRef _this,
9595
/// @param prop A JavaScript string object to reference a member of `_this` object.
9696
/// @param payload1 A result pointer of first payload of JavaScript value to set the target object.
9797
/// @param payload2 A result pointer of second payload of JavaScript value to set the target object.
98-
/// @return A JavaScriptValueKind bits represented as 32bit integer for the returned value.
98+
/// @return A `JavaScriptValueKind` bits represented as 32bit integer for the returned value.
9999
__attribute__((__import_module__("javascript_kit"),
100100
__import_name__("swjs_get_prop")))
101101
extern uint32_t _get_prop(
@@ -126,7 +126,7 @@ extern void _set_subscript(const JavaScriptObjectRef _this,
126126
/// @param index A subscript index to get value.
127127
/// @param payload1 A result pointer of first payload of JavaScript value to get the target object.
128128
/// @param payload2 A result pointer of second payload of JavaScript value to get the target object.
129-
/// @return A JavaScriptValueKind bits represented as 32bit integer for the returned value.
129+
/// @return A `JavaScriptValueKind` bits represented as 32bit integer for the returned value.
130130
__attribute__((__import_module__("javascript_kit"),
131131
__import_name__("swjs_get_subscript")))
132132
extern uint32_t _get_subscript(
@@ -180,7 +180,7 @@ extern JavaScriptObjectRef _i64_to_bigint_slow(unsigned int lower, unsigned int
180180
/// @param argc The length of `argv``.
181181
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
182182
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
183-
/// @return A JavaScriptValueKindAndFlags bits represented as 32bit integer for the returned value.
183+
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
184184
__attribute__((__import_module__("javascript_kit"),
185185
__import_name__("swjs_call_function")))
186186
extern uint32_t _call_function(
@@ -197,7 +197,7 @@ extern uint32_t _call_function(
197197
/// @param argc The length of `argv``.
198198
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
199199
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
200-
/// @return A JavaScriptValueKindAndFlags bits represented as 32bit integer for the returned value.
200+
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
201201
__attribute__((__import_module__("javascript_kit"),
202202
__import_name__("swjs_call_function_no_catch")))
203203
extern uint32_t _call_function_no_catch(
@@ -215,7 +215,7 @@ extern uint32_t _call_function_no_catch(
215215
/// @param argc The length of `argv``.
216216
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
217217
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
218-
/// @return A JavaScriptValueKindAndFlags bits represented as 32bit integer for the returned value.
218+
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
219219
__attribute__((__import_module__("javascript_kit"),
220220
__import_name__("swjs_call_function_with_this")))
221221
extern uint32_t _call_function_with_this(
@@ -234,7 +234,7 @@ extern uint32_t _call_function_with_this(
234234
/// @param argc The length of `argv``.
235235
/// @param result_payload1 A result pointer of first payload of JavaScript value of returned result or thrown exception.
236236
/// @param result_payload2 A result pointer of second payload of JavaScript value of returned result or thrown exception.
237-
/// @return A JavaScriptValueKindAndFlags bits represented as 32bit integer for the returned value.
237+
/// @return A `JavaScriptValueKindAndFlags` bits represented as 32bit integer for the returned value.
238238
__attribute__((__import_module__("javascript_kit"),
239239
__import_name__("swjs_call_function_with_this_no_catch")))
240240
extern uint32_t _call_function_with_this_no_catch(

0 commit comments

Comments
 (0)