From 0dc7086c4f16de02379cb279ab645af80e7aaa00 Mon Sep 17 00:00:00 2001 From: Fredrik Bagge Carlson <cont-frb@ulund.org> Date: Sun, 20 Aug 2017 22:07:44 +0200 Subject: [PATCH] Include documentation --- src/LabProcesses.jl | 1 + src/interface_documentation.jl | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/LabProcesses.jl b/src/LabProcesses.jl index 6cd40f1..df0f70d 100644 --- a/src/LabProcesses.jl +++ b/src/LabProcesses.jl @@ -3,6 +3,7 @@ module LabProcesses using ControlSystems include("interface.jl") +include("interface_documentation.jl") include("interface_implementations/ballandbeam.jl") include("utilities.jl") diff --git a/src/interface_documentation.jl b/src/interface_documentation.jl index fa3f18f..59e6de5 100644 --- a/src/interface_documentation.jl +++ b/src/interface_documentation.jl @@ -7,13 +7,13 @@ Base abstract type for all lab processes. This should not be inherited from dire AbstractProcess """ - PhysicalProcess + PhysicalProcess <: AbstractProcess Pysical processes should inherit from this abstract type. """ PhysicalProcess """ - SimulatedProcess + SimulatedProcess <: AbstractProcess Simulated processes should inherit from this abstract type. """ SimulatedProcess @@ -38,7 +38,7 @@ tuples, `length(range) = num_outputs(P), eltype(range) = Tuple(Real, Real)` outputrange """ - inputrange(P::AbstractProcess) + range = inputrange(P::AbstractProcess) Return the range of inputs (control signals) of the process. `range` is a vector of tuples, `length(range) = num_inputs(P), eltype(range) = Tuple(Real, Real)` """ -- GitLab