Skip to content

Commit 7285667

Browse files
committed
upd
1 parent 697106c commit 7285667

1 file changed

Lines changed: 2 additions & 9 deletions

File tree

src/packages.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,9 @@ trace( com.color.types.Color(0x10_00_00) );
4949
trace( Color(0x10_00_00) );
5050
```
5151

52-
## ShockDoc comment
52+
## ReadMe
5353

54-
A `package` definition may have a prefix ShockDoc comment, allowing to document the package once.
55-
56-
```
57-
/**
58-
* Enumerations used in the core runtime.
59-
*/
60-
package com.business.coreRT.enum {}
61-
```
54+
A directory identifying a package relative to a source path may contain a README file (either `README` or `README.md`) written as Markdown text, which serves as a means to attach documentation to the package.
6255

6356
## Package single import
6457

0 commit comments

Comments
 (0)