(Doc) Comment template files for connecting generated code with a Lea…

…rningEnvironment.
lucascarvalhoroncoroni · Sep 8, 2021 · ab8b6b9 · ab8b6b9
1 parent fc40dcf
commit ab8b6b9
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/doc/codeGen/TemplateAdversarialLE.cpp b/doc/codeGen/TemplateAdversarialLE.cpp
@@ -1,3 +1,13 @@
+/**
+* This file is a template that can be filled to connect C code generated with
+* the code generation feature from Gegelati with an
+* AdversarialLearningEnvironment AND (optionally) to compare its behaviour
+* with the TPG from Gegelati, imported from its dot format.
+*
+* To use this template, the following changes should be made, carefully read
+* and replace all comments in this file.
+*/
+
 #include <iostream>
 
 extern "C" {

diff --git a/doc/codeGen/TemplateLearningEnvironment.cpp b/doc/codeGen/TemplateLearningEnvironment.cpp
@@ -1,3 +1,13 @@
+/**
+* This file is a template that can be filled to connect C code generated with
+* the code generation feature from Gegelati with a LearningEnvironment AND
+* (optionally) to compare its behaviour with the TPG from Gegelati, imported
+* from its dot format.
+*
+* To use this template, the following changes should be made, carefully read
+* and replace all comments in this file.
+*/
+
 #include <iostream>
 
 extern "C" {