Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit 37802b4

Browse files
committed
docs: Use /** */ comments for all built-in LCB syntax
1 parent 2bc9319 commit 37802b4

22 files changed

Lines changed: 453 additions & 509 deletions

engine/src/canvas.lcb

Lines changed: 157 additions & 157 deletions
Large diffs are not rendered by default.

engine/src/engine.lcb

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
You should have received a copy of the GNU General Public License
1515
along with LiveCode. If not see <http://www.gnu.org/licenses/>. */
1616

17-
/*
17+
/**
1818
This library provides operations for interacting with LiveCode Script from LiveCode Builder.
1919

2020
Tags: Engine
@@ -63,7 +63,7 @@ public foreign handler MCEngineRemoveRunloopAction(in pAction as MCRunloopAction
6363
public foreign handler MCEngineRunloopWait() returns CBool binds to "<builtin>"
6464
public foreign handler MCEngineRunloopBreakWait() returns nothing binds to "<builtin>"
6565

66-
/*
66+
/**
6767
Summary: Resolves a string to a script object.
6868
Object: The string describing the script object.
6969

@@ -93,7 +93,7 @@ begin
9393
MCEngineExecResolveScriptObject(Object)
9494
end syntax
9595

96-
/*
96+
/**
9797
Summary: Tests the existence of a script object.
9898
Object: An expression that evaluates to a <ScriptObject>.
9999

@@ -121,7 +121,7 @@ begin
121121
MCEngineEvalScriptObjectExists(Object, output)
122122
end syntax
123123

124-
/*
124+
/**
125125
Summary: Tests the existence of a script object.
126126
Object: An expression that evaluates to a <ScriptObject>.
127127

@@ -147,7 +147,7 @@ begin
147147
MCEngineEvalScriptObjectDoesNotExist(Object, output)
148148
end syntax
149149

150-
/*
150+
/**
151151
Summary: The property of a script object.
152152
Property: The name of the property to manipulate
153153
Object: An expression that evaluates to a <ScriptObject>.
@@ -179,7 +179,7 @@ begin
179179
MCEngineExecSetPropertyOfScriptObject(input, Property, Object)
180180
end syntax
181181

182-
/*
182+
/**
183183
Summary: Get the parent object of a script object.
184184
Object: An expression that evaluates to a <ScriptObject>.
185185
The result: The <ScriptObject> that is the owner of <Object>.
@@ -207,7 +207,7 @@ begin
207207
MCEngineEvalOwnerOfScriptObject(Object, output)
208208
end syntax
209209

210-
/*
210+
/**
211211
Summary: Get the child objects of a script object.
212212
Object: An expression that evaluates to a <ScriptObject>
213213
The result: A list of <ScriptObject>s that are contained within <Object>.
@@ -238,7 +238,7 @@ begin
238238
MCEngineEvalChildrenOfScriptObject(Object, output)
239239
end syntax
240240

241-
/*
241+
/**
242242
Summary: Send a message to a script object.
243243
Message: The message to dispatch.
244244
Object: The script object to dispatch the message to.
@@ -279,7 +279,7 @@ begin
279279
MCEngineExecSendToScriptObjectWithArguments(IsFunction, Message, Object, Arguments)
280280
end syntax
281281

282-
/*
282+
/**
283283
Summary: Post a message to a script object.
284284
Message: The message to dispatch.
285285
Object: The script object to dispatch the message to.
@@ -303,7 +303,7 @@ begin
303303
MCEngineExecPostToScriptObjectWithArguments(Message, Object, Arguments)
304304
end syntax
305305

306-
/*
306+
/**
307307
Summary: Determines whether a message was handled
308308

309309
Example:
@@ -325,7 +325,7 @@ begin
325325
MCEngineEvalMessageWasHandled(output)
326326
end syntax
327327

328-
/*
328+
/**
329329
Summary: Determines whether a message was handled
330330

331331
Example:
@@ -346,7 +346,7 @@ begin
346346
MCEngineEvalMessageWasNotHandled(output)
347347
end syntax
348348

349-
/*
349+
/**
350350
Summary: Executes some LiveCode script.
351351
Script: The script to execute.
352352

@@ -373,7 +373,7 @@ begin
373373
MCEngineExecExecuteScript(Script)
374374
end syntax
375375

376-
/*
376+
/**
377377
Summary: Logs a string.
378378
String: The string to log.
379379
Arguments: A list of arguments.

0 commit comments

Comments
 (0)