-
Notifications
You must be signed in to change notification settings - Fork 1
/
package.scala
44 lines (39 loc) · 899 Bytes
/
package.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package docSample
/**
* If you are having trouble getting the package descriptions to show up with scaladoc,
* the following might help:
*
* - Place package description in a file called ''package.scala''</br>
* - Make sure the directory structure matches precisely the package structure</br>
* - Make sure the ''package.scala'' file is in its corresponding directory</br>
*
* The root `package.scala` file should look like:
*
* {{{
* /**
* * Scaladoc comments
* *
* * Note: No beginning package statement for the root package.
* */
package object rootPackage
* }}}
*
* <br/>
* A sub `package.scala` file should look like:
*
* {{{
* package rootPackage
*
* /**
* * Scaladoc comments
* */
package object subPackage
* }}}
*
*
* Back to the beginning, [[docSample]]
*
* @author [[http://me@keithpinson.com Keith Pinson]]
*
*/
package object subCode