class comments

badetitou · May 3, 2023 · e9dedc3 · e9dedc3
1 parent e75ba62
commit e9dedc3
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/src/Carrefour-FastAndBindingGenerator/CRFBinderVisitor.class.st b/src/Carrefour-FastAndBindingGenerator/CRFBinderVisitor.class.st
@@ -1,3 +1,8 @@
+"
+Binds FAST nodes to their corresponding FamixEntities
+
+Visit the F-AST and create binding between variable accesses (`FASTJavaFieldAccess`, `FASTJavaAssignementExpression`, `FASTJavaIdentifier`, ...) or method invocations (`FASTJavaMethodInvocation`) and their Famix counter-part (`FamixTStructuralEntity`, `FamixTInvocation`, ...)
+"
 Class {
 	#name : #CRFBinderVisitor,
 	#superclass : #FASTJavaVisitor,

diff --git a/src/Carrefour-Model/CRFModel.class.st b/src/Carrefour-Model/CRFModel.class.st
@@ -1,3 +1,7 @@
+"
+MetaModel of Carrefour.
+Does not define any entity, but ""imports"" entities from Famix and FAST and add relations between them
+"
 Class {
 	#name : #CRFModel,
 	#superclass : #MooseModel,

diff --git a/src/Carrefour-RemoveBinding/CRFBindingCleaner.class.st b/src/Carrefour-RemoveBinding/CRFBindingCleaner.class.st
@@ -1,3 +1,8 @@
+"
+This is the opposite of `CRFBinderVisitor`, it un-binds FAST entities and Famix entities.
+
+Puts `nil` in the FAST/Famix relations so that FAST objects can be garbage collected (also empties the CarrefourModel)
+"
 Class {
 	#name : #CRFBindingCleaner,
 	#superclass : #FASTJavaVisitor,