Skip to content

Commit b2fca27

Browse files
Gabriel-DarbordGabriel-Darbord
authored
Merge pull request #700 from moosetechnology/generated-comment-header
Header row in generated comments
2 parents 2924817 + 127d033 commit b2fca27

File tree

310 files changed

+743
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

310 files changed

+743
-0
lines changed

‎src/Famix-Deprecated/FamixTHasModifiers.trait.st

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
======================
44
55
| Name | Type | Default value | Comment |
6+
|---|
67
| `modifiers` | `String` | nil | Generic container for language dependent modifiers.|
78
89
"

‎src/Famix-Java-Entities/FamixJavaAccess.class.st

+4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
55
### Association source
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `accessor` | `FamixTAccess` | `accesses` | `FamixTWithAccesses` | Behavioural entity making the access to the variable. from-side of the association|
89
910
### Association target
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `variable` | `FamixTAccess` | `incomingAccesses` | `FamixTAccessible` | Variable accessed. to-side of the association|
1214
1315
### Other
1416
| Relation | Origin | Opposite | Type | Comment |
17+
|---|
1518
| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer|
1619
| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer|
1720
| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity|
@@ -21,6 +24,7 @@
2124
======================
2225
2326
| Name | Type | Default value | Comment |
27+
|---|
2428
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
2529
| `isWrite` | `Boolean` | false | Write access|
2630

‎src/Famix-Java-Entities/FamixJavaAnnotationInstance.class.st

+2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
55
### Children
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `attributes` | `FamixTWithAnnotationInstanceAttributes` | `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | This corresponds to the actual values of the attributes in an AnnotationInstance|
89
910
### Other
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `annotatedEntity` | `FamixTAnnotationInstance` | `annotationInstances` | `FamixTWithAnnotationInstances` | The NamedEntity on which the annotation occurs.|
1214
| `annotationType` | `FamixTTypedAnnotationInstance` | `instances` | `FamixTAnnotationType` | Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). |
1315

‎src/Famix-Java-Entities/FamixJavaAnnotationInstanceAttribute.class.st

+3
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,20 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | `attributes` | `FamixTWithAnnotationInstanceAttributes` | The instance of the annotation in which the attribute is used.|
89
910
### Other
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance|
1214
1315
1416
## Properties
1517
======================
1618
1719
| Name | Type | Default value | Comment |
20+
|---|
1821
| `value` | `String` | nil | Actual value of the attribute used in an annotation|
1922
2023
"

‎src/Famix-Java-Entities/FamixJavaAnnotationType.class.st

+6
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,29 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `annotationTypesContainer` | `FamixTAnnotationType` | `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | Container in which an AnnotationType may reside|
89
| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)|
910
1011
### Children
1112
| Relation | Origin | Opposite | Type | Comment |
13+
|---|
1214
| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.|
1315
1416
### Outgoing dependencies
1517
| Relation | Origin | Opposite | Type | Comment |
18+
|---|
1619
| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.|
1720
1821
### Incoming dependencies
1922
| Relation | Origin | Opposite | Type | Comment |
23+
|---|
2024
| `implementations` | `FamixTImplementable` | `interface` | `FamixTImplementation` | Implementation relationships.|
2125
| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.|
2226
2327
### Other
2428
| Relation | Origin | Opposite | Type | Comment |
29+
|---|
2530
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
2631
| `instances` | `FamixTAnnotationType` | `annotationType` | `FamixTTypedAnnotationInstance` | Annotations of this type|
2732
@@ -30,6 +35,7 @@
3035
======================
3136
3237
| Name | Type | Default value | Comment |
38+
|---|
3339
| `visibility` | `String` | nil | Visibility of the entity|
3440
3541
"

‎src/Famix-Java-Entities/FamixJavaAnnotationTypeAttribute.class.st

+4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation|
89
910
### Incoming dependencies
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity|
1214
1315
### Other
1416
| Relation | Origin | Opposite | Type | Comment |
17+
|---|
1518
| `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances|
1619
| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance|
1720
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
@@ -23,6 +26,7 @@
2326
======================
2427
2528
| Name | Type | Default value | Comment |
29+
|---|
2630
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
2731
| `name` | `String` | nil | Basic name of the entity, not full reference.|
2832

‎src/Famix-Java-Entities/FamixJavaAttribute.class.st

+4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation|
89
910
### Incoming dependencies
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity|
1214
1315
### Other
1416
| Relation | Origin | Opposite | Type | Comment |
17+
|---|
1518
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
1619
| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any|
1720
| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)|
@@ -22,6 +25,7 @@
2225
======================
2326
2427
| Name | Type | Default value | Comment |
28+
|---|
2529
| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static|
2630
| `isFinal` | `Boolean` | false | Entity can be declared final|
2731
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|

‎src/Famix-Java-Entities/FamixJavaClass.class.st

+6
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,33 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)|
89
| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).|
910
1011
### Children
1112
| Relation | Origin | Opposite | Type | Comment |
13+
|---|
1214
| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.|
1315
| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.|
1416
1517
### Outgoing dependencies
1618
| Relation | Origin | Opposite | Type | Comment |
19+
|---|
1720
| `interfaceImplementations` | `FamixTCanImplement` | `implementingClass` | `FamixTImplementation` | Implementation relationships|
1821
| `outgoingImports` | `FamixTWithImports` | `importingEntity` | `FamixTImport` | |
1922
| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.|
2023
2124
### Incoming dependencies
2225
| Relation | Origin | Opposite | Type | Comment |
26+
|---|
2327
| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity|
2428
| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.|
2529
| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.|
2630
2731
### Other
2832
| Relation | Origin | Opposite | Type | Comment |
33+
|---|
2934
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
3035
| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)|
3136
| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity|
@@ -36,6 +41,7 @@
3641
======================
3742
3843
| Name | Type | Default value | Comment |
44+
|---|
3945
| `isAbstract` | `Boolean` | false | Entity can be declared abstract|
4046
| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static|
4147
| `isFinal` | `Boolean` | false | Entity can be declared final|

‎src/Famix-Java-Entities/FamixJavaComment.class.st

+2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
55
### Other
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment|
89
910
1011
## Properties
1112
======================
1213
1314
| Name | Type | Default value | Comment |
15+
|---|
1416
| `content` | `String` | nil | Content of the comment as a String|
1517
1618
"

‎src/Famix-Java-Entities/FamixJavaConcretisation.class.st

+4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
55
### Association source
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `genericEntity` | `FamixTConcretisation` | `concretisations` | `FamixTParametricEntity` | genericEntity linked to in this relationship. from-side of the association|
89
910
### Association target
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `concreteEntity` | `FamixTConcretisation` | `genericEntity` | `FamixTParametricEntity` | concreteEntity linked to in this relationship. to-side of the association|
1214
1315
### Other
1416
| Relation | Origin | Opposite | Type | Comment |
17+
|---|
1518
| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer|
1619
| `parameterConcretisations` | `FamixTConcretisation` | `concretisations` | `FamixTParameterConcretisation` | |
1720
| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer|
@@ -22,6 +25,7 @@
2225
======================
2326
2427
| Name | Type | Default value | Comment |
28+
|---|
2529
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
2630
2731
"

‎src/Famix-Java-Entities/FamixJavaContainerEntity.class.st

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
55
### Children
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | `annotationTypesContainer` | `FamixTAnnotationType` | The container in which the AnnotationTypes may be declared|
89
| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any.
910
#types is declared in ContainerEntity because different kinds of container can embed types. Types are usually contained in a Famix.Namespace. But types can also be contained in a Famix.Class or Famix.Method (in Java with inner classes for example). Famix.Function can also contain some types such as structs.|

‎src/Famix-Java-Entities/FamixJavaEnum.class.st

+6
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,32 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).|
89
910
### Children
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.|
1214
| `enumValues` | `FamixTWithEnumValues` | `parentEnum` | `FamixTEnumValue` | |
1315
| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.|
1416
1517
### Outgoing dependencies
1618
| Relation | Origin | Opposite | Type | Comment |
19+
|---|
1720
| `outgoingImports` | `FamixTWithImports` | `importingEntity` | `FamixTImport` | |
1821
| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.|
1922
2023
### Incoming dependencies
2124
| Relation | Origin | Opposite | Type | Comment |
25+
|---|
2226
| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity|
2327
| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.|
2428
| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.|
2529
2630
### Other
2731
| Relation | Origin | Opposite | Type | Comment |
32+
|---|
2833
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
2934
| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity|
3035
| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType|
@@ -34,6 +39,7 @@
3439
======================
3540
3641
| Name | Type | Default value | Comment |
42+
|---|
3743
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
3844
| `name` | `String` | nil | Basic name of the entity, not full reference.|
3945
| `visibility` | `String` | nil | Visibility of the entity|

‎src/Famix-Java-Entities/FamixJavaEnumValue.class.st

+4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `parentEnum` | `FamixTEnumValue` | `enumValues` | `FamixTWithEnumValues` | The Enum declaring this value. It offers the implementation of belongsTo|
89
910
### Incoming dependencies
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity|
1214
1315
### Other
1416
| Relation | Origin | Opposite | Type | Comment |
17+
|---|
1518
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
1619
| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any|
1720
| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity|
@@ -21,6 +24,7 @@
2124
======================
2225
2326
| Name | Type | Default value | Comment |
27+
|---|
2428
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
2529
| `name` | `String` | nil | Basic name of the entity, not full reference.|
2630

‎src/Famix-Java-Entities/FamixJavaException.class.st

+6
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,32 @@
44
55
### Parents
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).|
89
910
### Children
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.|
1214
| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.|
1315
| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any.
1416
#types is declared in ContainerEntity because different kinds of container can embed types. Types are usually contained in a Famix.Namespace. But types can also be contained in a Famix.Class or Famix.Method (in Java with inner classes for example). Famix.Function can also contain some types such as structs.|
1517
1618
### Outgoing dependencies
1719
| Relation | Origin | Opposite | Type | Comment |
20+
|---|
1821
| `interfaceImplementations` | `FamixTCanImplement` | `implementingClass` | `FamixTImplementation` | Implementation relationships|
1922
| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.|
2023
2124
### Incoming dependencies
2225
| Relation | Origin | Opposite | Type | Comment |
26+
|---|
2327
| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.|
2428
| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.|
2529
2630
### Other
2731
| Relation | Origin | Opposite | Type | Comment |
32+
|---|
2833
| `annotationInstances` | `FamixTWithAnnotationInstances` | `annotatedEntity` | `FamixTAnnotationInstance` | This property corresponds to the set of annotations associated to the entity|
2934
| `catchingEntities` | `FamixTThrowable` | `caughtExceptions` | `FamixTWithExceptions` | |
3035
| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity|
@@ -39,6 +44,7 @@
3944
======================
4045
4146
| Name | Type | Default value | Comment |
47+
|---|
4248
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
4349
| `name` | `String` | nil | Basic name of the entity, not full reference.|
4450
| `visibility` | `String` | nil | Visibility of the entity|

‎src/Famix-Java-Entities/FamixJavaImplementation.class.st

+4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
55
### Association source
66
| Relation | Origin | Opposite | Type | Comment |
7+
|---|
78
| `implementingClass` | `FamixTImplementation` | `interfaceImplementations` | `FamixTCanImplement` | Class linked to in this relationship. from-side of the association|
89
910
### Association target
1011
| Relation | Origin | Opposite | Type | Comment |
12+
|---|
1113
| `interface` | `FamixTImplementation` | `implementations` | `FamixTImplementable` | Interface linked to in this relationship. to-side of the association|
1214
1315
### Other
1416
| Relation | Origin | Opposite | Type | Comment |
17+
|---|
1518
| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer|
1619
| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer|
1720
| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity|
@@ -21,6 +24,7 @@
2124
======================
2225
2326
| Name | Type | Default value | Comment |
27+
|---|
2428
| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
2529
2630
"

0 commit comments

Comments
 (0)