Skip to content

Commit af1a492

Browse files
committed
fix reference format in scaladoc
1 parent 4a9fc0d commit af1a492

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

jvm/src/main/scala/gopher/JVMGopher.scala

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@ object JVMGopher extends GopherAPI:
5454
case jcfg:JVMGopherConfig => jcfg
5555
new JVMGopher[F](jvmConfig)
5656

57-
//lazy val timer = new Timer("gopher")
58-
5957
lazy val scheduledExecutor = Executors.newScheduledThreadPool(1)
6058

6159
lazy val defaultConfig=JVMGopherConfig(

shared/src/main/scala/gopher/Channel.scala

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ import scala.concurrent.duration.FiniteDuration
66

77
import gopher.impl._
88

9+
/**
10+
* Channel with ability to read and to write.
11+
* @see [[gopher.ReadChannel]]
12+
* @see [[gopher.WriteChannel]]
13+
**/
914
trait Channel[F[_],W,R] extends WriteChannel[F,W] with ReadChannel[F,R] with Closeable:
1015

1116
override def gopherApi: Gopher[F]

shared/src/main/scala/gopher/Gopher.scala

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ import java.util.concurrent.Executor
1616
* Process here - scala units of execution (i.e. functions, blok of code, etc).
1717
* Communication channels represented by [gopher.Channel]
1818
*
19-
* @see [gopher.Channel]
20-
* @see [gopher#select]
19+
* @see [[gopher.Channel]]
20+
* @see [[gopher#select]]
2121
**/
2222
trait Gopher[F[_]:CpsSchedulingMonad]:
2323

@@ -48,13 +48,14 @@ trait Gopher[F[_]:CpsSchedulingMonad]:
4848

4949
/***
5050
*Create a select statement, which used for choosing one action from a set of potentially concurrent asynchronics events.
51-
*[@see gopher.Select]
51+
*[@see [[gopher.Select#apply]]
5252
**/
5353
def select: Select[F] =
5454
new Select[F](this)
5555

5656
/**
5757
* get an object with time operations.
58+
* @see [[gopher.Time]]
5859
**/
5960
def time: Time[F]
6061

0 commit comments

Comments
 (0)