Fix docs

deps/build.jl

@@ -9,6 +9,7 @@ function buildDeps()
   Pkg.add("DataStructures")
   Pkg.add("MacroTools")
   Pkg.add("ImmutableList")
+  Pkg.add("Setfield")
   @info("Build all dependencies succesfull")
 end
 

docs/make.jl

@@ -0,0 +1,4 @@
+push!(LOAD_PATH,"../src/")
+using Documenter, MetaModelica
+
+makedocs(sitename="My Documentation")

docs/src/index.md

@@ -0,0 +1,21 @@
+# MetaModelica.jl Documentation
+
+```@meta
+CurrentModule = MetaModelica
+```
+
+## Outline
+```@contents
+Pages = [
+    "man/runtime.md",
+    "man/matchin.md",
+    "man/list.md",
+    "man/semantics.md",
+]
+Depth = 1
+```
+
+## Index
+
+```@index
+```

docs/src/man/list.md

@@ -0,0 +1,15 @@
+```@meta
+CurrentModule = MetaModelica
+```
+
+```@contents
+```
+
+## List operations
+```@docs
+do_threaded_for
+<|
+shouldFail
+sourceInfo
+_cons
+```

docs/src/man/matchin.md

@@ -0,0 +1,6 @@
+## Patternmatching
+```@docs
+@match
+@matchcontinue
+MatchFailure
+```

docs/src/man/runtime.md

@@ -0,0 +1,134 @@
+## Runtime Functions provided by MetaModelica.jl
+```@docs
+ anyString
+ arrayAppend
+ arrayCopy
+ arrayCreate
+ arrayEmpty
+ arrayGet
+ arrayLength
+ arrayList
+ arrayUpdate
+ boolNot
+ boolAnd
+ boolEq
+ boolOr
+ boolString
+ clock
+ cons
+ debug_print
+ equality
+ fail
+ getGlobalRoot
+ intAbs
+ intAdd
+ intBitLShift
+ intBitNot
+ intBitOr
+ intBitRShift
+ intBitXor
+ intDiv
+ intEq
+ intGe
+ intGt
+ intLe
+ intLt
+ intMax
+ intMin
+ intMod
+ intMul
+ intMul
+ intNe
+ intNeg
+ intReal
+ intString
+ intStringChar
+ intSub
+ isNone
+ isPresent
+ isSome
+ listAppend
+ listArray
+ listDelete
+ listEmpty
+ listGet
+ listHead
+ listLength
+ listMember
+ listRest
+ listReverse
+ listReverseInPlace
+ listStringCharString
+ printAny
+ realAbs
+ realAdd
+ realDiv
+ realEq
+ realGe
+ realGt
+ realInt
+ realLe
+ realLt
+ realMax
+ realMin
+ realMod
+ realMul
+ realNe
+ realNeg
+ realNeg
+ realPow
+ realString
+ realSub
+ referenceDebugString
+ referenceEq
+ referencePointerString
+ setGlobalRoot
+ setStackOverflowSignal
+ stringAppend
+ stringAppendList
+ stringCharInt
+ stringCharListString
+ stringCompare
+ stringDelimitList
+ stringEmpty
+ stringEqual
+ stringEq
+ stringGet
+ stringGetStringChar
+ stringHash
+ stringHashDjb2
+ stringHashDjb2Mod
+ stringHashSdbm
+ stringInt
+ stringLength
+ stringListStringChar
+ stringReal
+ stringUpdateStringChar
+ substring
+ tick
+ valueCompare
+ valueConstructor
+ valueEq
+ valueHashMod
+ valueSlots
+ _listAppend
+ getInstanceName
+ StringFunction
+ ```
+
+## Patternmatching
+```@docs
+match
+matchcontinue
+MatchFailure
+```
+## Extended Semantics
+```
+Uniontype
+Record
+UniontypeDecl
+ExtendedFunction
+ExtendedAnonFunction
+assign
+shouldFail
+```

docs/src/man/semantics.md

@@ -0,0 +1,14 @@
+## Semantic extensions
+
+This package provides various extensions to the semantics of the Julia language.
+The extensions provided by this package are listed below.
+
+```@docs
+@Uniontype
+@Record
+@UniontypeDecl
+@ExtendedFunction
+@ExtendedAnonFunction
+@assign
+@shouldFail
+```

src/metaModelicaTypes.jl

@@ -15,7 +15,6 @@ TODO:
 =#
 
 abstract type MetaModelicaException <: Exception end
-
 export ModelicaInteger, ModelicaReal, MetaModelicaException
 
 end

src/metaRuntime.jl

@@ -487,7 +487,7 @@ function substring(str::String, start #=start index, first character is 1 =#::Mo
   out
 end
 
-""" O(1) ? """
+""" O(1) """
 function arrayLength(arr::Array{T})::ModelicaInteger where {T}
   length(arr)
 end
@@ -511,7 +511,7 @@ function arrayCreate(size::ModelicaInteger, initialValue::A)::Array{A} where {A}
   fill(initialValue, size)
 end
 
-""" Better """
+""" Creates an array out of a List """
 function arrayList(arr::Array{T})::List{T} where {T}
   local lst::List{T} = nil
   for i in length(arr):-1:1
@@ -649,7 +649,7 @@ function valueEq(a1::A, a2::B)::Bool where {A, B}
   b
 end
 
-""" a1 > a2? """
+""" a1 > a2 """
 function valueCompare(a1::A, a2::A)::ModelicaInteger where {A}
   local i::ModelicaInteger =
     if valueConstructor(a1) < valueConstructor(a2)