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

Commit cc4927b

Browse files
committed
Use correct comment syntax in docs on documentation
1 parent 64a705f commit cc4927b

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/guides/LiveCode Documentation Format Reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ etc.
235235
### Inline documentation
236236
Documentation for LiveCode script and LiveCode extensions can be done in-line. In this case, the Name, Type, Syntax and Associated elements are auto-generated.
237237

238-
The code-block enclosed in /* */ immediately preceding the handler or syntax definition is used for the other elements of the documentation for that entry. In LiveCode extensions, the types of parameters are also pulled from the associated handler.
238+
The code-block enclosed in /** */ immediately preceding the handler or syntax definition is used for the other elements of the documentation for that entry. In LiveCode extensions, the types of parameters are also pulled from the associated handler.
239239

240240
### Separate docs files examples
241241

@@ -344,13 +344,13 @@ In general, writing inline docs has fewer requirements since several of the elem
344344
#### LiveCode Builder syntax example
345345

346346
```
347-
/*
347+
/**
348348
This library consists of the operations on lists included in the standard library of LiveCode Builder.
349349
*/
350350
351351
module com.livecode.list
352352
353-
/*
353+
/**
354354
Summary: Returns the first element of <Target>.
355355
Target: An expression which evaluates to a list.
356356
output: The first element of <Target>
@@ -387,7 +387,7 @@ end module
387387

388388
#### LiveCode Builder handler example
389389
```
390-
/*
390+
/**
391391
Summary: Logs the result of a test to the <xResults> list
392392
393393
Parameters:
@@ -415,7 +415,7 @@ end handler
415415
```
416416
#### LiveCode script handler example
417417
```
418-
/*
418+
/**
419419
Summary: Extracts the inline docs from a .lcb file
420420
421421
pFile: The path to the .lcb file to extract docs from

docs/notes/bugfix-19417.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Use correct comment syntax in docs on documentation

0 commit comments

Comments
 (0)