Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

Commit

Permalink
fix broken links iun scaladoc
Browse files Browse the repository at this point in the history
  • Loading branch information
drexin committed Apr 29, 2015
1 parent 8061306 commit b5a22d0
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ import scala.collection.JavaConversions._
* The facade to the mesos simulation.
*
* It starts/stops a new actor system for the simulation when the corresponding life-cycle methods of the
* [[SchedulerDriver]] interface are called.
* [[org.apache.mesos.SchedulerDriver]] interface are called.
*
* The implemented commands of the driver interface are forwarded as messages to the [[DriverActor]].
* Unimplemented methods throw [[NotImplementedError]]s.
* The implemented commands of the driver interface are forwarded as messages to the
* [[mesosphere.mesos.simulation.DriverActor]].
* Unimplemented methods throw [[scala.NotImplementedError]]s.
*/
class SimulatedDriver(driverProps: Props) extends SchedulerDriver {

Expand Down
2 changes: 1 addition & 1 deletion src/main/scala/mesosphere/marathon/MarathonModule.scala
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ class MarathonModule(conf: MarathonConf, http: HttpConf, zk: ZooKeeperClient)
@Singleton
def provideActorSystem(): ActorSystem = ActorSystem("marathon")

/** Reexports the [[ActorSystem]] as [[ActorRefFactory]]. It doesn't work automatically. */
/* Reexports the `akka.actor.ActorSystem` as `akka.actor.ActorRefFactory`. It doesn't work automatically. */
@Provides
@Singleton
def provideActorRefFactory(system: ActorSystem): ActorRefFactory = system
Expand Down
2 changes: 1 addition & 1 deletion src/main/scala/mesosphere/marathon/state/Group.scala
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ case class Group(
/**
* Remove the app with the given id if it is a direct child of this group.
*
* Use together with [[update]].
* Use together with [[mesosphere.marathon.state.Group!.update(timestamp*]].
*/
def removeApplication(appId: PathId): Group = copy(apps = apps.filter(_.id != appId))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ final case class DeploymentStep(actions: Seq[DeploymentAction]) {
}

/**
* A deployment plan consists of the [[DeploymentStep]]s necessary to
* A deployment plan consists of the [[mesosphere.marathon.upgrade.DeploymentStep]]s necessary to
* change the group state from original to target.
*
* The steps are executed sequentially after each other. The actions within a
* step maybe executed in parallel.
*
* See [[mesosphere.marathon.upgrade.DeploymentPlan.appsGroupedByLongestPath]] to
* See `mesosphere.marathon.upgrade.DeploymentPlan.appsGroupedByLongestPath` to
* understand how we can guarantee that all dependencies for a step are fulfilled
* by prior steps.
*/
Expand All @@ -61,8 +61,6 @@ final case class DeploymentPlan(

/**
* Reverts this plan by applying the reverse changes to the given Group.
*
* See [[DeploymentPlanReverter.revert]].
*/
def revert(group: Group): Group = DeploymentPlanReverter.revert(original, target)(group)

Expand Down
2 changes: 1 addition & 1 deletion src/main/scala/mesosphere/util/PromiseActor.scala
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class PromiseActor(promise: Promise[Any]) extends Actor {
object PromiseActor {
/**
* Sends the given message to the given actorRef and waits indefinitely for the response. The response
* must be of the given type T or a [[Status.Failure]].
* must be of the given type T or a `akka.actor.Status.Failure`.
*
* @param actorRefFactory the factory for creating the internally used actor
* @param actorRef references the actor to send the message to
Expand Down
8 changes: 4 additions & 4 deletions src/main/scala/mesosphere/util/SerializeExecutionActor.scala
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import scala.concurrent.Future
import scala.util.control.NonFatal

/**
* Allows the sequential execution of methods which return [[Future]]s.
* The execution of a [[Future]] waits for the prior Future to complete (not only the
* Allows the sequential execution of methods which return `scala.concurrent.Future`s.
* The execution of a `scala.concurrent.Future` waits for the prior Future to complete (not only the
* method returning the Future).
*
* {{{
Expand Down Expand Up @@ -48,8 +48,8 @@ class SerializeExecution private (actorRefFactory: ActorRefFactory, actorName: S
}

/**
* Accepts messages containing functions returning [[Future]]s.
* It starts the execution of a function after the [[Future]]s generated
* Accepts messages containing functions returning `scala.concurrent.Future`s.
* It starts the execution of a function after the `scala.concurrent.Future`s generated
* by prior functions have been completed.
*/
private[util] class SerializeExecutionActor extends Actor {
Expand Down

0 comments on commit b5a22d0

Please sign in to comment.