From 01fb3a499f4a9094c68b7f738bb34306eac674d9 Mon Sep 17 00:00:00 2001 From: ovainola Date: Fri, 26 Jun 2015 19:00:23 +0300 Subject: [PATCH] Added new documentation --- docs/api/JuliaFEM.elasticity_solver.md | 14 +++++++------- docs/api/JuliaFEM.md | 10 +++++----- docs/api/README.md | 2 ++ 3 files changed, 14 insertions(+), 12 deletions(-) create mode 100644 docs/api/README.md diff --git a/docs/api/JuliaFEM.elasticity_solver.md b/docs/api/JuliaFEM.elasticity_solver.md index baafae9..99a6ede 100644 --- a/docs/api/JuliaFEM.elasticity_solver.md +++ b/docs/api/JuliaFEM.elasticity_solver.md @@ -22,7 +22,7 @@ is calculated and eldofs are "extended" to problem dimension. *source:* -[JuliaFEM/src/elasticity_solver.jl:171](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L171) +[JuliaFEM/src/elasticity_solver.jl:171](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L171) --- @@ -44,7 +44,7 @@ is calculated and eldofs are "extended" to problem dimension. *source:* -[JuliaFEM/src/elasticity_solver.jl:130](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L130) +[JuliaFEM/src/elasticity_solver.jl:130](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L130) --- @@ -54,7 +54,7 @@ Calculate local tangent stiffness matrix and residual force vector R = T - F *source:* -[JuliaFEM/src/elasticity_solver.jl:68](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L68) +[JuliaFEM/src/elasticity_solver.jl:68](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L68) --- @@ -87,7 +87,7 @@ DX=2 for some node, for example. *source:* -[JuliaFEM/src/elasticity_solver.jl:218](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L218) +[JuliaFEM/src/elasticity_solver.jl:218](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L218) --- @@ -119,7 +119,7 @@ DX=2 for some node, for example. *source:* -[JuliaFEM/src/elasticity_solver.jl:257](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L257) +[JuliaFEM/src/elasticity_solver.jl:257](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L257) --- @@ -140,7 +140,7 @@ ip :: Array{Number, 1} *source:* -[JuliaFEM/src/elasticity_solver.jl:30](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L30) +[JuliaFEM/src/elasticity_solver.jl:30](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L30) --- @@ -150,5 +150,5 @@ Solve one increment of elasticity problem *source:* -[JuliaFEM/src/elasticity_solver.jl:278](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/elasticity_solver.jl#L278) +[JuliaFEM/src/elasticity_solver.jl:278](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/elasticity_solver.jl#L278) diff --git a/docs/api/JuliaFEM.md b/docs/api/JuliaFEM.md index 442b178..10bacef 100644 --- a/docs/api/JuliaFEM.md +++ b/docs/api/JuliaFEM.md @@ -28,7 +28,7 @@ In dict key means element id *source:* -[JuliaFEM/src/JuliaFEM.jl:102](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/JuliaFEM.jl#L102) +[JuliaFEM/src/JuliaFEM.jl:102](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/JuliaFEM.jl#L102) --- @@ -47,7 +47,7 @@ Dict *source:* -[JuliaFEM/src/JuliaFEM.jl:126](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/JuliaFEM.jl#L126) +[JuliaFEM/src/JuliaFEM.jl:126](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/JuliaFEM.jl#L126) --- @@ -72,7 +72,7 @@ Error, if field not found and create_if_doesnt_exist == false *source:* -[JuliaFEM/src/JuliaFEM.jl:67](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/JuliaFEM.jl#L67) +[JuliaFEM/src/JuliaFEM.jl:67](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/JuliaFEM.jl#L67) --- @@ -90,7 +90,7 @@ New model struct *source:* -[JuliaFEM/src/JuliaFEM.jl:41](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/JuliaFEM.jl#L41) +[JuliaFEM/src/JuliaFEM.jl:41](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/JuliaFEM.jl#L41) --- @@ -100,5 +100,5 @@ Basic model *source:* -[JuliaFEM/src/JuliaFEM.jl:19](https://github.com/JuliaFEM/JuliaFEM.jl/tree/e4544d2b8d034469617e908134cbae74008ba189/src/JuliaFEM.jl#L19) +[JuliaFEM/src/JuliaFEM.jl:19](https://github.com/JuliaFEM/JuliaFEM.jl/tree/1e1704126d7c25595a71838fd8a59ba5d2212219/src/JuliaFEM.jl#L19) diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 0000000..f11064e --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,2 @@ +Files in this directory are generated using the `build.jl` script. Make +all changes to the originating docstrings/files rather than these ones.