DOC: add missing/improve existing documentation

jasmineRepo / JAS-mine-core

JAS-mine maintains and develops the JAS simulation platform, a discrete-event tool-kit for agent-based and dynamic microsimulation modelling. This repository contains the core libraries. See www.jas-mine.net for more details.

2 stars 5 forks source link

DOC: add missing/improve existing documentation #12

Open vkhodygo opened 2 years ago

vkhodygo commented 2 years ago

The code documentation is somewhat lacking, both for end users and developers. The task list below contains all code sections to be checked:

[ ] Agent
[ ] Alignment
[ ] Annotation
[ ] Collection
[ ] Data
[ ] Engine
[ ] Event
[ ] Exception
[ ] Matching
[ ] Reflection
[ ] Space
[ ] Statistics

UPD # 1 Move all commentaries to the documentation. Everything that is marked as TODO has to be removed and moved to separate issues.

UPD # 2 Add build/use instructions.