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+ /**
1818This library provides operations for interacting with LiveCode Script from LiveCode Builder.
1919
2020Tags: Engine
@@ -63,7 +63,7 @@ public foreign handler MCEngineRemoveRunloopAction(in pAction as MCRunloopAction
6363public foreign handler MCEngineRunloopWait() returns CBool binds to "<builtin>"
6464public foreign handler MCEngineRunloopBreakWait() returns nothing binds to "<builtin>"
6565
66- /*
66+ /**
6767Summary: Resolves a string to a script object.
6868Object: The string describing the script object.
6969
9393 MCEngineExecResolveScriptObject(Object)
9494end syntax
9595
96- /*
96+ /**
9797Summary: Tests the existence of a script object.
9898Object: An expression that evaluates to a <ScriptObject>.
9999
@@ -121,7 +121,7 @@ begin
121121 MCEngineEvalScriptObjectExists(Object, output)
122122end syntax
123123
124- /*
124+ /**
125125Summary: Tests the existence of a script object.
126126Object: An expression that evaluates to a <ScriptObject>.
127127
@@ -147,7 +147,7 @@ begin
147147 MCEngineEvalScriptObjectDoesNotExist(Object, output)
148148end syntax
149149
150- /*
150+ /**
151151Summary: The property of a script object.
152152Property: The name of the property to manipulate
153153Object: An expression that evaluates to a <ScriptObject>.
@@ -179,7 +179,7 @@ begin
179179 MCEngineExecSetPropertyOfScriptObject(input, Property, Object)
180180end syntax
181181
182- /*
182+ /**
183183Summary: Get the parent object of a script object.
184184Object: An expression that evaluates to a <ScriptObject>.
185185The result: The <ScriptObject> that is the owner of <Object>.
@@ -207,7 +207,7 @@ begin
207207 MCEngineEvalOwnerOfScriptObject(Object, output)
208208end syntax
209209
210- /*
210+ /**
211211Summary: Get the child objects of a script object.
212212Object: An expression that evaluates to a <ScriptObject>
213213The result: A list of <ScriptObject>s that are contained within <Object>.
@@ -238,7 +238,7 @@ begin
238238 MCEngineEvalChildrenOfScriptObject(Object, output)
239239end syntax
240240
241- /*
241+ /**
242242Summary: Send a message to a script object.
243243Message: The message to dispatch.
244244Object: The script object to dispatch the message to.
@@ -279,7 +279,7 @@ begin
279279 MCEngineExecSendToScriptObjectWithArguments(IsFunction, Message, Object, Arguments)
280280end syntax
281281
282- /*
282+ /**
283283Summary: Post a message to a script object.
284284Message: The message to dispatch.
285285Object: The script object to dispatch the message to.
@@ -303,7 +303,7 @@ begin
303303 MCEngineExecPostToScriptObjectWithArguments(Message, Object, Arguments)
304304end syntax
305305
306- /*
306+ /**
307307Summary: Determines whether a message was handled
308308
309309Example:
@@ -325,7 +325,7 @@ begin
325325 MCEngineEvalMessageWasHandled(output)
326326end syntax
327327
328- /*
328+ /**
329329Summary: Determines whether a message was handled
330330
331331Example:
@@ -346,7 +346,7 @@ begin
346346 MCEngineEvalMessageWasNotHandled(output)
347347end syntax
348348
349- /*
349+ /**
350350Summary: Executes some LiveCode script.
351351Script: The script to execute.
352352
@@ -373,7 +373,7 @@ begin
373373 MCEngineExecExecuteScript(Script)
374374end syntax
375375
376- /*
376+ /**
377377Summary: Logs a string.
378378String: The string to log.
379379Arguments: A list of arguments.
0 commit comments