Generated entities

fuhrmanator · Jul 30, 2024 · 0364f20 · 0364f20
1 parent 39c1992
commit 0364f20
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 28 deletions.
diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptComment.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptComment.class.st
@@ -14,13 +14,17 @@
 | Name | Type | Default value | Comment |
 |---|
 | `content` | `String` | nil | Content of the comment as a String|
+| `isJSDoc` | `Boolean` | false | Comments can have the form of JSDoc.|
 
 "
 Class {
 	#name : #FamixTypeScriptComment,
 	#superclass : #FamixTypeScriptSourcedEntity,
 	#traits : 'FamixTComment',
 	#classTraits : 'FamixTComment classTrait',
+	#instVars : [
+		'#isJSDoc => FMProperty defaultValue: false'
+	],
 	#category : #'Famix-TypeScript-Entities-Entities'
 }
 
@@ -32,3 +36,18 @@ FamixTypeScriptComment class >> annotation [
 	<generated>
 	^ self
 ]
+
+{ #category : #accessing }
+FamixTypeScriptComment >> isJSDoc [
+
+	<FMProperty: #isJSDoc type: #Boolean defaultValue: false>
+	<generated>
+	<FMComment: 'Comments can have the form of JSDoc.'>
+	^ isJSDoc ifNil: [ isJSDoc := false ]
+]
+
+{ #category : #accessing }
+FamixTypeScriptComment >> isJSDoc: anObject [
+	<generated>
+	isJSDoc := anObject
+]
diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptEnum.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptEnum.class.st
@@ -12,7 +12,6 @@ I represent a Typescript enumerated type
 ### Children
 | Relation | Origin | Opposite | Type | Comment |
 |---|
-| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
 | `enumValues` | `FamixTWithEnumValues` | `parentEnum` | `FamixTEnumValue` | |
 
 ### Incoming dependencies
@@ -40,8 +39,8 @@ I represent a Typescript enumerated type
 Class {
 	#name : #FamixTypeScriptEnum,
 	#superclass : #FamixTypeScriptType,
-	#traits : 'FamixTEnum + FamixTImportable + FamixTWithComments',
-	#classTraits : 'FamixTEnum classTrait + FamixTImportable classTrait + FamixTWithComments classTrait',
+	#traits : 'FamixTEnum + FamixTImportable',
+	#classTraits : 'FamixTEnum classTrait + FamixTImportable classTrait',
 	#category : #'Famix-TypeScript-Entities-Entities'
 }
 

diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptEnumValue.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptEnumValue.class.st
@@ -9,11 +9,6 @@ I represent One value (constant) in a Typescript enumerated type
 |---|
 | `parentEnum` | `FamixTEnumValue` | `enumValues` | `FamixTWithEnumValues` | The Enum declaring this value. It offers the implementation of belongsTo|
 
-### Children
-| Relation | Origin | Opposite | Type | Comment |
-|---|
-| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
-
 ### Incoming dependencies
 | Relation | Origin | Opposite | Type | Comment |
 |---|
@@ -38,8 +33,8 @@ I represent One value (constant) in a Typescript enumerated type
 Class {
 	#name : #FamixTypeScriptEnumValue,
 	#superclass : #FamixTypeScriptStructuralEntity,
-	#traits : 'FamixTEnumValue + FamixTWithComments',
-	#classTraits : 'FamixTEnumValue classTrait + FamixTWithComments classTrait',
+	#traits : 'FamixTEnumValue',
+	#classTraits : 'FamixTEnumValue classTrait',
 	#category : #'Famix-TypeScript-Entities-Entities'
 }
 

diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptInterface.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptInterface.class.st
@@ -8,7 +8,6 @@ I represent a TypeScript interface.
 | Relation | Origin | Opposite | Type | Comment |
 |---|
 | `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.|
-| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
 | `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.|
 
 ### Outgoing dependencies
@@ -33,8 +32,8 @@ I represent a TypeScript interface.
 Class {
 	#name : #FamixTypeScriptInterface,
 	#superclass : #FamixTypeScriptType,
-	#traits : 'FamixTImplementable + FamixTInvocationsReceiver + FamixTWithAttributes + FamixTWithComments + FamixTWithInheritances + FamixTWithMethods',
-	#classTraits : 'FamixTImplementable classTrait + FamixTInvocationsReceiver classTrait + FamixTWithAttributes classTrait + FamixTWithComments classTrait + FamixTWithInheritances classTrait + FamixTWithMethods classTrait',
+	#traits : 'FamixTImplementable + FamixTInvocationsReceiver + FamixTWithAttributes + FamixTWithInheritances + FamixTWithMethods',
+	#classTraits : 'FamixTImplementable classTrait + FamixTInvocationsReceiver classTrait + FamixTWithAttributes classTrait + FamixTWithInheritances classTrait + FamixTWithMethods classTrait',
 	#category : #'Famix-TypeScript-Entities-Entities'
 }
 

diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptMethod.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptMethod.class.st
@@ -12,7 +12,6 @@ I represent a TypeScript method.
 ### Children
 | Relation | Origin | Opposite | Type | Comment |
 |---|
-| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
 | `implicitVariables` | `FamixTWithImplicitVariables` | `parentBehaviouralEntity` | `FamixTImplicitVariable` | Implicit variables used locally by this behaviour.|
 | `localVariables` | `FamixTWithLocalVariables` | `parentBehaviouralEntity` | `FamixTLocalVariable` | Variables locally defined by this behaviour.|
 | `parameters` | `FamixTWithParameters` | `parentBehaviouralEntity` | `FamixTParameter` | List of formal parameters declared by this behaviour.|
@@ -54,8 +53,8 @@ I represent a TypeScript method.
 Class {
 	#name : #FamixTypeScriptMethod,
 	#superclass : #FamixTypeScriptBehaviouralEntity,
-	#traits : 'FamixTCanBeAbstract + FamixTCanBeClassSide + FamixTHasKind + FamixTHasVisibility + FamixTImportable + FamixTMethod + FamixTWithComments',
-	#classTraits : 'FamixTCanBeAbstract classTrait + FamixTCanBeClassSide classTrait + FamixTHasKind classTrait + FamixTHasVisibility classTrait + FamixTImportable classTrait + FamixTMethod classTrait + FamixTWithComments classTrait',
+	#traits : 'FamixTCanBeAbstract + FamixTCanBeClassSide + FamixTHasKind + FamixTHasVisibility + FamixTImportable + FamixTMethod',
+	#classTraits : 'FamixTCanBeAbstract classTrait + FamixTCanBeClassSide classTrait + FamixTHasKind classTrait + FamixTHasVisibility classTrait + FamixTImportable classTrait + FamixTMethod classTrait',
 	#category : #'Famix-TypeScript-Entities-Entities'
 }
 

diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptModule.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptModule.class.st
@@ -5,7 +5,6 @@
 ### Children
 | Relation | Origin | Opposite | Type | Comment |
 |---|
-| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
 | `localVariables` | `FamixTWithLocalVariables` | `parentBehaviouralEntity` | `FamixTLocalVariable` | Variables locally defined by this behaviour.|
 
 ### Outgoing dependencies
@@ -24,8 +23,8 @@
 Class {
 	#name : #FamixTypeScriptModule,
 	#superclass : #FamixTypeScriptScriptEntity,
-	#traits : 'FamixTImportable + FamixTWithComments + FamixTWithImports + FamixTWithLocalVariables',
-	#classTraits : 'FamixTImportable classTrait + FamixTWithComments classTrait + FamixTWithImports classTrait + FamixTWithLocalVariables classTrait',
+	#traits : 'FamixTImportable + FamixTWithImports + FamixTWithLocalVariables',
+	#classTraits : 'FamixTImportable classTrait + FamixTWithImports classTrait + FamixTWithLocalVariables classTrait',
 	#instVars : [
 		'#isAmbient',
 		'#isModule',

diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptParameter.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptParameter.class.st
@@ -7,11 +7,6 @@
 |---|
 | `parentBehaviouralEntity` | `FamixTParameter` | `parameters` | `FamixTWithParameters` | Behavioural entity containing this parameter. belongsTo implementation|
 
-### Children
-| Relation | Origin | Opposite | Type | Comment |
-|---|
-| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
-
 ### Incoming dependencies
 | Relation | Origin | Opposite | Type | Comment |
 |---|
@@ -36,8 +31,8 @@
 Class {
 	#name : #FamixTypeScriptParameter,
 	#superclass : #FamixTypeScriptStructuralEntity,
-	#traits : 'FamixTParameter + FamixTWithComments',
-	#classTraits : 'FamixTParameter classTrait + FamixTWithComments classTrait',
+	#traits : 'FamixTParameter',
+	#classTraits : 'FamixTParameter classTrait',
 	#category : #'Famix-TypeScript-Entities-Entities'
 }
 

diff --git a/src/Famix-TypeScript-Entities/FamixTypeScriptSourcedEntity.class.st b/src/Famix-TypeScript-Entities/FamixTypeScriptSourcedEntity.class.st
@@ -2,6 +2,11 @@
 ## Relations
 ======================
 
+### Children
+| Relation | Origin | Opposite | Type | Comment |
+|---|
+| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
+
 ### Other
 | Relation | Origin | Opposite | Type | Comment |
 |---|
@@ -19,8 +24,8 @@
 Class {
 	#name : #FamixTypeScriptSourcedEntity,
 	#superclass : #FamixTypeScriptEntity,
-	#traits : 'FamixTSourceEntity',
-	#classTraits : 'FamixTSourceEntity classTrait',
+	#traits : 'FamixTSourceEntity + FamixTWithComments',
+	#classTraits : 'FamixTSourceEntity classTrait + FamixTWithComments classTrait',
 	#category : #'Famix-TypeScript-Entities-Entities'
 }