Skip to content

Commit b7bb187

Browse files
Merge pull request #279 from EliasH-E/docsEdit
Added docs for DataNodes.h and WorldSetup.cc, changed comments in SymWorld.h to avoid DoxyGen
2 parents edeed4d + 5cc9883 commit b7bb187

2 files changed

Lines changed: 3 additions & 7 deletions

File tree

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
breathe_default_project = "Symbulation"
5151

5252
breathe_projects_source = {
53-
"auto" : ( "../source", ["default_mode/Host.h", "default_mode/Symbiont.h","default_mode/SymWorld.h","efficient_mode/EfficientHost.h"
53+
"auto" : ( "../source", ["default_mode/Host.h", "default_mode/Symbiont.h","default_mode/SymWorld.h","default_mode/DataNodes.h","default_mode/WorldSetup.cc","efficient_mode/EfficientHost.h"
5454
,"efficient_mode/EfficientSymbiont.h","efficient_mode/EfficientWorld.h","lysis_mode/Bacterium.h","lysis_mode/Phage.h","lysis_mode/LysisWorld.h",
5555
"pgg_mode/PGGHost.h","pgg_mode/PGGSymbiont.h","pgg_mode/PGGWorld.h","SymAnimate.h"] )
5656
}

source/default_mode/SymWorld.h

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -609,9 +609,7 @@ class SymWorld : public emp::World<Organism>{
609609
}
610610

611611

612-
/**
613-
* Definitions of data node functions, expanded in DataNodes.h
614-
*/
612+
//Definitions of data node functions, expanded in DataNodes.h
615613
virtual void CreateDataFiles();
616614
void MapPhylogenyInteractions();
617615
void WritePhylogenyFile(const std::string & filename);
@@ -662,9 +660,7 @@ class SymWorld : public emp::World<Organism>{
662660
emp::DataMonitor<double,emp::data::Histogram>& GetWithinHostVarianceDataNode();
663661

664662

665-
/**
666-
* Definitions of setup functions, expanded in WorldSetup.cc
667-
*/
663+
//Definitions of setup functions, expanded in WorldSetup.cc
668664
virtual void Setup();
669665
virtual void SetupHosts(long unsigned int* POP_SIZE);
670666
virtual void SetupSymbionts(long unsigned int* total_syms);

0 commit comments

Comments
 (0)