Documentation of SysDyn updated.

TerraME · Jul 17, 2015 · 73385aa · 73385aa
1 parent f34a08b
commit 73385aa
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/lua/SysDynModel.lua b/lua/SysDynModel.lua
@@ -6,17 +6,20 @@
 -- of the model will be drawn in the screen. It can have three values:
 -- @tabular graphics
 -- Graphics  & Description \
--- "timeseries" & Draw a time series. \
--- "cobweb" &  Draw a cobweb plot. \
--- "phasespace" & Draw a phase state plot.\
+-- "timeseries" & A table with internal tables describing sets of attributes to be
+-- drawn with time as x axis. \
+-- "cobweb" &  Draw a cobweb plot. Not implemented yet. \
+-- "phasespace" & A table with internal tables with the attributes to be drawn
+-- as a phase space. The first attribute of every internal table will be used as
+-- x axis.
 -- @arg data.... Any other value that can be used as parameter for the Model.
 -- @usage Tube = SysDynModel{
 --     water = 20,
 --     changes = function(model)
 --         model.water = model.water - 1
 --     end,
 --     graphics = {
---         timeseries = {{"pop"}},
+--         timeseries = {{"water"}},
 --     }
 -- }
 function SysDynModel(data)