Small tweaks

Author: BenLauwens

src/SimJulia.jl

@@ -1,8 +1,6 @@
 isdefined(Base, :__precompile__) && __precompile__()
 
 """
-  `SimJulia`
-
 Main module for SimJulia.jl – a combined continuous time / discrete event process oriented simulation framework for Julia.
 """
 module SimJulia

src/events.jl

@@ -33,12 +33,12 @@ Timeout{E<:Environment} <: AbstractEvent{E}
 
 **Field**:
 
-- `bev :: BaseEvent{E}`
+- bev :: BaseEvent{E}
 
 **Constructors**:
 
-- `Timeout{E<:Environment}(env::E, delay::Period; priority::Bool=false, value::Any=nothing) :: Timeout{E}`
-- `Timeout{E<:Environment}(env::E, delay::Number=0; priority::Bool=false, value::Any=nothing) :: Timeout{E}`
+- Timeout{E<:Environment}(env::E, delay::Period; priority::Bool=false, value::Any=nothing)
+- Timeout{E<:Environment}(env::E, delay::Number=0; priority::Bool=false, value::Any=nothing)
 """
 
 type Timeout{E<:Environment} <: AbstractEvent{E}

src/process.jl

@@ -11,14 +11,14 @@ Process{E<:Environment} <: AbstractEvent{E}
 
 **Fields**:
 
-- `bev :: BaseEvent{E}`
-- `task :: Task`
-- `target :: AbstractEvent{E}`
-- `resume :: Function`
+- bev :: BaseEvent{E}
+- task :: Task
+- target :: AbstractEvent{E}
+- resume :: Function
 
 **Constructor**:
 
-Process{E<:Environment}(func::Function, env::E, args::Any...) :: Process{E}
+Process{E<:Environment}(func::Function, env::E, args::Any...)
 """
 type Process{E<:Environment} <: AbstractEvent{E}
   bev :: BaseEvent{E}

src/simulation.jl

@@ -18,16 +18,16 @@ Simulation{T<:TimeType} <: Environment
 
 **Fields**:
 
-- `time :: T`
-- `heap :: PriorityQueue{BaseEvent{Simulation{T}}, EventKey{T}}`
-- `eid :: UInt`
-- `sid :: UInt`
-- `active_proc :: Nullable{Process}`
+- time :: T
+- heap :: PriorityQueue{BaseEvent{Simulation{T}}, EventKey{T}}
+- eid :: UInt
+- sid :: UInt
+- active_proc :: Nullable{Process}
 
 **Constructors**:
 
-- `Simulation{T<:TimeType}(initial_time::T) :: Simulation{T}`
-- `Simulation(initial_time::Number=0) :: Simulation{SimulationTime}`
+- Simulation{T<:TimeType}(initial_time::T) :: Simulation{T}
+- Simulation(initial_time::Number=0) :: Simulation{SimulationTime}
 
 An initial_time for the simulation can be specified. By default, it starts at 0.
 """
@@ -54,7 +54,7 @@ end
 Returns the current simulation time.
 
 **Method**:
-`now{T<:TimeType}(sim::Simulation{T}) :: T`
+now{T<:TimeType}(sim::Simulation{T}) :: T
 """
 function now{T<:TimeType}(sim::Simulation{T}) :: T
   sim.time
@@ -90,7 +90,7 @@ Does a simulation step and processes the next event.
 
 **Method**:
 
-`step(sim::Simulation) :: Bool`
+step(sim::Simulation) :: Bool
 """
 function step(sim::Simulation)
   if isempty(sim.heap)
@@ -120,10 +120,10 @@ If the stepping end with a `StopSimulation` exception the function return the va
 
 **Methods**:
 
-  - `run(sim::Simulation, until::AbstractEvent) :: Any`
-  - `run{T<:TimeType}(sim::Simulation{T}, until::T) :: Any`
-  - `run(sim::Simulation, period::Union{Period, Number}) :: Any`
-  - `run(sim::Simulation) :: Any`
+  - run(sim::Simulation, until::AbstractEvent) :: Any
+  - run{T<:TimeType}(sim::Simulation{T}, until::T) :: Any
+  - run(sim::Simulation, period::Union{Period, Number}) :: Any
+  - run(sim::Simulation) :: Any
 """
 function run{T<:TimeType}(sim::Simulation{T}, until::AbstractEvent{Simulation{T}}) :: Any
   append_callback(stop_simulation, until)
@@ -154,7 +154,7 @@ end
 
 function schedule{T<:TimeType}(bev::BaseEvent{Simulation{T}}, delay::Period; priority::Bool=false, value::Any=nothing)
   bev.value = value
-  bev.env.heap[bev] = EventKey(bev.env.time + delay, priority, bev.env.sid+=one(UInt))
+  bev.env.heap[bev] = EventKey{T}(bev.env.time + delay, priority, bev.env.sid+=one(UInt))
   bev.state = scheduled
 end