diff --git a/src/Famix-Deprecated/FamixTHasModifiers.trait.st b/src/Famix-Deprecated/FamixTHasModifiers.trait.st index 26fe9513..18fc5b60 100644 --- a/src/Famix-Deprecated/FamixTHasModifiers.trait.st +++ b/src/Famix-Deprecated/FamixTHasModifiers.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #modifiers Type: String Comment: Generic container for language dependent modifiers. +| Name | Type | Default value | Comment | +| `modifiers` | `String` | nil | Generic container for language dependent modifiers.| " Trait { diff --git a/src/Famix-Java-Entities/FamixJavaAccess.class.st b/src/Famix-Java-Entities/FamixJavaAccess.class.st index 81a8f6b5..01e4b1a9 100644 --- a/src/Famix-Java-Entities/FamixJavaAccess.class.st +++ b/src/Famix-Java-Entities/FamixJavaAccess.class.st @@ -3,19 +3,26 @@ ====================== ### Association source -- Relation: #accessor Type: #FamixTWithAccesses Opposite: #accesses Comment: Behavioural entity making the access to the variable. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `accessor` | `FamixTAccess` | `accesses` | `FamixTWithAccesses` | Behavioural entity making the access to the variable. from-side of the association| + ### Association target -- Relation: #variable Type: #FamixTAccessible Opposite: #incomingAccesses Comment: Variable accessed. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `variable` | `FamixTAccess` | `incomingAccesses` | `FamixTAccessible` | Variable accessed. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #isWrite Type: Boolean Comment: Write access +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `isWrite` | `Boolean` | false | Write access| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaAnnotationInstance.class.st b/src/Famix-Java-Entities/FamixJavaAnnotationInstance.class.st index 14e86d26..f3c32cd1 100644 --- a/src/Famix-Java-Entities/FamixJavaAnnotationInstance.class.st +++ b/src/Famix-Java-Entities/FamixJavaAnnotationInstance.class.st @@ -3,10 +3,14 @@ ====================== ### Children -- Relation: #attributes Type: #FamixTAnnotationInstanceAttribute Opposite: #parentAnnotationInstance Comment: This corresponds to the actual values of the attributes in an AnnotationInstance +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAnnotationInstanceAttributes` | `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | This corresponds to the actual values of the attributes in an AnnotationInstance| + ### Other -- Relation: #annotatedEntity Type: #FamixTWithAnnotationInstances Opposite: #annotationInstances Comment: The NamedEntity on which the annotation occurs. -- Relation: #annotationType Type: #FamixTAnnotationType Opposite: #instances Comment: Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). +| Relation | Origin | Opposite | Type | Comment | +| `annotatedEntity` | `FamixTAnnotationInstance` | `annotationInstances` | `FamixTWithAnnotationInstances` | The NamedEntity on which the annotation occurs.| +| `annotationType` | `FamixTTypedAnnotationInstance` | `instances` | `FamixTAnnotationType` | Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). | + " diff --git a/src/Famix-Java-Entities/FamixJavaAnnotationInstanceAttribute.class.st b/src/Famix-Java-Entities/FamixJavaAnnotationInstanceAttribute.class.st index 134c4ec5..2286d71a 100644 --- a/src/Famix-Java-Entities/FamixJavaAnnotationInstanceAttribute.class.st +++ b/src/Famix-Java-Entities/FamixJavaAnnotationInstanceAttribute.class.st @@ -3,14 +3,19 @@ ====================== ### Parents -- Relation: #parentAnnotationInstance Type: #FamixTWithAnnotationInstanceAttributes Opposite: #attributes Comment: The instance of the annotation in which the attribute is used. +| Relation | Origin | Opposite | Type | Comment | +| `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | `attributes` | `FamixTWithAnnotationInstanceAttributes` | The instance of the annotation in which the attribute is used.| + ### Other -- Relation: #annotationTypeAttribute Type: #FamixTAnnotationTypeAttribute Opposite: #annotationAttributeInstances Comment: This corresponds to the type of the attribute in an AnnotationInstance +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance| + ## Properties ====================== -- Named: #value Type: String Comment: Actual value of the attribute used in an annotation +| Name | Type | Default value | Comment | +| `value` | `String` | nil | Actual value of the attribute used in an annotation| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaAnnotationType.class.st b/src/Famix-Java-Entities/FamixJavaAnnotationType.class.st index 3e3b191f..26a5e7e6 100644 --- a/src/Famix-Java-Entities/FamixJavaAnnotationType.class.st +++ b/src/Famix-Java-Entities/FamixJavaAnnotationType.class.st @@ -3,23 +3,34 @@ ====================== ### Parents -- Relation: #annotationTypesContainer Type: #FamixTWithAnnotationTypes Opposite: #definedAnnotationTypes Comment: Container in which an AnnotationType may reside -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypesContainer` | `FamixTAnnotationType` | `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | Container in which an AnnotationType may reside| +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #implementations Type: #FamixTImplementation Opposite: #interface Comment: Implementation relationships. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `implementations` | `FamixTImplementable` | `interface` | `FamixTImplementation` | Implementation relationships.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #instances Type: #FamixTTypedAnnotationInstance Opposite: #annotationType Comment: Annotations of this type +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `instances` | `FamixTAnnotationType` | `annotationType` | `FamixTTypedAnnotationInstance` | Annotations of this type| + ## Properties ====================== -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaAnnotationTypeAttribute.class.st b/src/Famix-Java-Entities/FamixJavaAnnotationTypeAttribute.class.st index 5c83f71d..73facc6b 100644 --- a/src/Famix-Java-Entities/FamixJavaAnnotationTypeAttribute.class.st +++ b/src/Famix-Java-Entities/FamixJavaAnnotationTypeAttribute.class.st @@ -3,21 +3,28 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #annotationAttributeInstances Type: #FamixTTypedAnnotationInstanceAttribute Opposite: #annotationTypeAttribute Comment: A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances -- Relation: #annotationTypeAttribute Type: #FamixTAnnotationTypeAttribute Opposite: #annotationAttributeInstances Comment: This corresponds to the type of the attribute in an AnnotationInstance -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances| +| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance| +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaAttribute.class.st b/src/Famix-Java-Entities/FamixJavaAttribute.class.st index 65d1da19..ce6ed133 100644 --- a/src/Famix-Java-Entities/FamixJavaAttribute.class.st +++ b/src/Famix-Java-Entities/FamixJavaAttribute.class.st @@ -3,25 +3,32 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isFinal Type: Boolean Comment: Entity can be declared final -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #isTransient Type: Boolean Comment: Entity can be declared transient -- Named: #isVolatile Type: Boolean Comment: Entity can be declared volatile -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| +| `isFinal` | `Boolean` | false | Entity can be declared final| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `isTransient` | `Boolean` | false | Entity can be declared transient| +| `isVolatile` | `Boolean` | false | Entity can be declared volatile| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaClass.class.st b/src/Famix-Java-Entities/FamixJavaClass.class.st index de073d69..05c27bda 100644 --- a/src/Famix-Java-Entities/FamixJavaClass.class.st +++ b/src/Famix-Java-Entities/FamixJavaClass.class.st @@ -3,34 +3,45 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #interfaceImplementations Type: #FamixTImplementation Opposite: #implementingClass Comment: Implementation relationships -- Relation: #outgoingImports Type: #FamixTImport Opposite: #importingEntity -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `interfaceImplementations` | `FamixTCanImplement` | `implementingClass` | `FamixTImplementation` | Implementation relationships| +| `outgoingImports` | `FamixTWithImports` | `importingEntity` | `FamixTImport` | | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingImports Type: #FamixTImport Opposite: #importedEntity Comment: List of imports of this entity -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity| +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isAbstract Type: Boolean Comment: Entity can be declared abstract -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isFinal Type: Boolean Comment: Entity can be declared final -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isAbstract` | `Boolean` | false | Entity can be declared abstract| +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| +| `isFinal` | `Boolean` | false | Entity can be declared final| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaComment.class.st b/src/Famix-Java-Entities/FamixJavaComment.class.st index f5072a6d..640152dd 100644 --- a/src/Famix-Java-Entities/FamixJavaComment.class.st +++ b/src/Famix-Java-Entities/FamixJavaComment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaContainerEntity.class.st b/src/Famix-Java-Entities/FamixJavaContainerEntity.class.st index 5d82eafb..0f8a56d9 100644 --- a/src/Famix-Java-Entities/FamixJavaContainerEntity.class.st +++ b/src/Famix-Java-Entities/FamixJavaContainerEntity.class.st @@ -3,9 +3,11 @@ ====================== ### Children -- Relation: #definedAnnotationTypes Type: #FamixTAnnotationType Opposite: #annotationTypesContainer Comment: The container in which the AnnotationTypes may be declared -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | `annotationTypesContainer` | `FamixTAnnotationType` | The container in which the AnnotationTypes may be declared| +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + " diff --git a/src/Famix-Java-Entities/FamixJavaEnum.class.st b/src/Famix-Java-Entities/FamixJavaEnum.class.st index ae26ed12..6d6dc9be 100644 --- a/src/Famix-Java-Entities/FamixJavaEnum.class.st +++ b/src/Famix-Java-Entities/FamixJavaEnum.class.st @@ -3,29 +3,40 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #enumValues Type: #FamixTEnumValue Opposite: #parentEnum -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `enumValues` | `FamixTWithEnumValues` | `parentEnum` | `FamixTEnumValue` | | +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #outgoingImports Type: #FamixTImport Opposite: #importingEntity -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `outgoingImports` | `FamixTWithImports` | `importingEntity` | `FamixTImport` | | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingImports Type: #FamixTImport Opposite: #importedEntity Comment: List of imports of this entity -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity| +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaEnumValue.class.st b/src/Famix-Java-Entities/FamixJavaEnumValue.class.st index f3acfb0f..4565f793 100644 --- a/src/Famix-Java-Entities/FamixJavaEnumValue.class.st +++ b/src/Famix-Java-Entities/FamixJavaEnumValue.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentEnum Type: #FamixTWithEnumValues Opposite: #enumValues Comment: The Enum declaring this value. It offers the implementation of belongsTo +| Relation | Origin | Opposite | Type | Comment | +| `parentEnum` | `FamixTEnumValue` | `enumValues` | `FamixTWithEnumValues` | The Enum declaring this value. It offers the implementation of belongsTo| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaException.class.st b/src/Famix-Java-Entities/FamixJavaException.class.st index 40c81fc4..3916fbd4 100644 --- a/src/Famix-Java-Entities/FamixJavaException.class.st +++ b/src/Famix-Java-Entities/FamixJavaException.class.st @@ -3,34 +3,45 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + ### Outgoing dependencies -- Relation: #interfaceImplementations Type: #FamixTImplementation Opposite: #implementingClass Comment: Implementation relationships -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `interfaceImplementations` | `FamixTCanImplement` | `implementingClass` | `FamixTImplementation` | Implementation relationships| +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #annotationInstances Type: #FamixTAnnotationInstance Opposite: #annotatedEntity Comment: This property corresponds to the set of annotations associated to the entity -- Relation: #catchingEntities Type: #FamixTWithExceptions Opposite: #caughtExceptions -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaringEntities Type: #FamixTWithExceptions Opposite: #declaredExceptions -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #throwingEntities Type: #FamixTWithExceptions Opposite: #thrownExceptions -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `annotationInstances` | `FamixTWithAnnotationInstances` | `annotatedEntity` | `FamixTAnnotationInstance` | This property corresponds to the set of annotations associated to the entity| +| `catchingEntities` | `FamixTException` | `caughtExceptions` | `FamixTWithExceptions` | | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaringEntities` | `FamixTException` | `declaredExceptions` | `FamixTWithExceptions` | | +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `throwingEntities` | `FamixTException` | `thrownExceptions` | `FamixTWithExceptions` | | +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaImplementation.class.st b/src/Famix-Java-Entities/FamixJavaImplementation.class.st index 95bd66ab..5061382e 100644 --- a/src/Famix-Java-Entities/FamixJavaImplementation.class.st +++ b/src/Famix-Java-Entities/FamixJavaImplementation.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #implementingClass Type: #FamixTCanImplement Opposite: #interfaceImplementations Comment: Class linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `implementingClass` | `FamixTImplementation` | `interfaceImplementations` | `FamixTCanImplement` | Class linked to in this relationship. from-side of the association| + ### Association target -- Relation: #interface Type: #FamixTImplementable Opposite: #implementations Comment: Interface linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `interface` | `FamixTImplementation` | `implementations` | `FamixTImplementable` | Interface linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaImplicitVariable.class.st b/src/Famix-Java-Entities/FamixJavaImplicitVariable.class.st index fc3f301a..f550c5f9 100644 --- a/src/Famix-Java-Entities/FamixJavaImplicitVariable.class.st +++ b/src/Famix-Java-Entities/FamixJavaImplicitVariable.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithImplicitVariables Opposite: #implicitVariables Comment: The behaviour containing this implicit variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTImplicitVariable` | `implicitVariables` | `FamixTWithImplicitVariables` | The behaviour containing this implicit variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaImport.class.st b/src/Famix-Java-Entities/FamixJavaImport.class.st index 3beb67b1..f7f6a96c 100644 --- a/src/Famix-Java-Entities/FamixJavaImport.class.st +++ b/src/Famix-Java-Entities/FamixJavaImport.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #importingEntity Type: #FamixTWithImports Opposite: #outgoingImports Comment: Importing entity +| Relation | Origin | Opposite | Type | Comment | +| `importingEntity` | `FamixTImport` | `outgoingImports` | `FamixTWithImports` | Importing entity| + ### Association target -- Relation: #importedEntity Type: #FamixTImportable Opposite: #incomingImports Comment: Imported entity +| Relation | Origin | Opposite | Type | Comment | +| `importedEntity` | `FamixTImport` | `incomingImports` | `FamixTImportable` | Imported entity| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaIndexedFileAnchor.class.st b/src/Famix-Java-Entities/FamixJavaIndexedFileAnchor.class.st index 75f0982b..87bcc9f1 100644 --- a/src/Famix-Java-Entities/FamixJavaIndexedFileAnchor.class.st +++ b/src/Famix-Java-Entities/FamixJavaIndexedFileAnchor.class.st @@ -2,11 +2,12 @@ ## Properties ====================== -- Named: #correspondingFile Type: FamixTFile Comment: File associated to this source anchor -- Named: #encoding Type: String Comment: A string representing the encoding of a file -- Named: #endPos Type: Number Comment: Stop position in the source -- Named: #fileName Type: String Comment: Name of the source file -- Named: #startPos Type: Number Comment: Start position in the source +| Name | Type | Default value | Comment | +| `correspondingFile` | `FamixTFile` | nil | File associated to this source anchor| +| `encoding` | `String` | nil | A string representing the encoding of a file| +| `endPos` | `Number` | nil | Stop position in the source| +| `fileName` | `String` | nil | Name of the source file| +| `startPos` | `Number` | nil | Start position in the source| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaInheritance.class.st b/src/Famix-Java-Entities/FamixJavaInheritance.class.st index b9c6c77d..4a5b928e 100644 --- a/src/Famix-Java-Entities/FamixJavaInheritance.class.st +++ b/src/Famix-Java-Entities/FamixJavaInheritance.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #subclass Type: #FamixTWithInheritances Opposite: #superInheritances Comment: Subclass linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `subclass` | `FamixTInheritance` | `superInheritances` | `FamixTWithInheritances` | Subclass linked to in this relationship. from-side of the association| + ### Association target -- Relation: #superclass Type: #FamixTWithInheritances Opposite: #subInheritances Comment: Superclass linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `superclass` | `FamixTInheritance` | `subInheritances` | `FamixTWithInheritances` | Superclass linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaInterface.class.st b/src/Famix-Java-Entities/FamixJavaInterface.class.st index 72075edb..7932d94b 100644 --- a/src/Famix-Java-Entities/FamixJavaInterface.class.st +++ b/src/Famix-Java-Entities/FamixJavaInterface.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #outgoingImports Type: #FamixTImport Opposite: #importingEntity -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `outgoingImports` | `FamixTWithImports` | `importingEntity` | `FamixTImport` | | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #implementations Type: #FamixTImplementation Opposite: #interface Comment: Implementation relationships. -- Relation: #incomingImports Type: #FamixTImport Opposite: #importedEntity Comment: List of imports of this entity -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `implementations` | `FamixTImplementable` | `interface` | `FamixTImplementation` | Implementation relationships.| +| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| + ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isFinal Type: Boolean Comment: Entity can be declared final -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| +| `isFinal` | `Boolean` | false | Entity can be declared final| +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaInvocation.class.st b/src/Famix-Java-Entities/FamixJavaInvocation.class.st index 1523362c..8b3959cc 100644 --- a/src/Famix-Java-Entities/FamixJavaInvocation.class.st +++ b/src/Famix-Java-Entities/FamixJavaInvocation.class.st @@ -3,20 +3,27 @@ ====================== ### Association source -- Relation: #sender Type: #FamixTWithInvocations Opposite: #outgoingInvocations Comment: Behavioural entity making the call. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `sender` | `FamixTInvocation` | `outgoingInvocations` | `FamixTWithInvocations` | Behavioural entity making the call. from-side of the association| + ### Association target -- Relation: #candidates Type: #FamixTInvocable Opposite: #incomingInvocations Comment: List of candidate behavioural entities for receiving the invocation +| Relation | Origin | Opposite | Type | Comment | +| `candidates` | `FamixTInvocation` | `incomingInvocations` | `FamixTInvocable` | List of candidate behavioural entities for receiving the invocation| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #receiver Type: #FamixTInvocationsReceiver Opposite: #receivingInvocations Comment: Named entity (variable, class...) receiving the invocation. to-side of the association -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `receiver` | `FamixTInvocation` | `receivingInvocations` | `FamixTInvocationsReceiver` | Named entity (variable, class...) receiving the invocation. to-side of the association| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaLocalVariable.class.st b/src/Famix-Java-Entities/FamixJavaLocalVariable.class.st index 69f29c77..e71d814c 100644 --- a/src/Famix-Java-Entities/FamixJavaLocalVariable.class.st +++ b/src/Famix-Java-Entities/FamixJavaLocalVariable.class.st @@ -3,21 +3,28 @@ ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithLocalVariables Opposite: #localVariables Comment: Behavioural entity declaring this local variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTLocalVariable` | `localVariables` | `FamixTWithLocalVariables` | Behavioural entity declaring this local variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isFinal Type: Boolean Comment: Entity can be declared final -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isFinal` | `Boolean` | false | Entity can be declared final| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaMethod.class.st b/src/Famix-Java-Entities/FamixJavaMethod.class.st index b0bd36a1..8f48176f 100644 --- a/src/Famix-Java-Entities/FamixJavaMethod.class.st +++ b/src/Famix-Java-Entities/FamixJavaMethod.class.st @@ -3,38 +3,49 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingImports Type: #FamixTImport Opposite: #importedEntity Comment: List of imports of this entity -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity| +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #caughtExceptions Type: #FamixTException Opposite: #catchingEntities Comment: The exceptions caught by the method -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredExceptions Type: #FamixTException Opposite: #declaringEntities Comment: The exceptions declared by the method -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #thrownExceptions Type: #FamixTException Opposite: #throwingEntities Comment: The exceptions thrown by the method +| Relation | Origin | Opposite | Type | Comment | +| `caughtExceptions` | `FamixTWithExceptions` | `catchingEntities` | `FamixTException` | The exceptions caught by the method| +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredExceptions` | `FamixTWithExceptions` | `declaringEntities` | `FamixTException` | The exceptions declared by the method| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `thrownExceptions` | `FamixTWithExceptions` | `throwingEntities` | `FamixTException` | The exceptions thrown by the method| + ## Properties ====================== -- Named: #isAbstract Type: Boolean Comment: Entity can be declared abstract -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isFinal Type: Boolean Comment: Entity can be declared final -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #isSynchronized Type: Boolean Comment: Entity can be declared synchronized -- Named: #kind Type: String Comment: Tag indicating a setter, getter, constant, constructor method -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isAbstract` | `Boolean` | false | Entity can be declared abstract| +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| +| `isFinal` | `Boolean` | false | Entity can be declared final| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `isSynchronized` | `Boolean` | false | Entity can be declared synchronized| +| `kind` | `String` | nil | Tag indicating a setter, getter, constant, constructor method| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| +| `visibility` | `String` | nil | Visibility of the entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaNamedEntity.class.st b/src/Famix-Java-Entities/FamixJavaNamedEntity.class.st index 4cbb8847..8a530465 100644 --- a/src/Famix-Java-Entities/FamixJavaNamedEntity.class.st +++ b/src/Famix-Java-Entities/FamixJavaNamedEntity.class.st @@ -3,13 +3,16 @@ ====================== ### Other -- Relation: #annotationInstances Type: #FamixTAnnotationInstance Opposite: #annotatedEntity Comment: This property corresponds to the set of annotations associated to the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) +| Relation | Origin | Opposite | Type | Comment | +| `annotationInstances` | `FamixTWithAnnotationInstances` | `annotatedEntity` | `FamixTAnnotationInstance` | This property corresponds to the set of annotations associated to the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| + ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaPackage.class.st b/src/Famix-Java-Entities/FamixJavaPackage.class.st index aacc3219..01ab565a 100644 --- a/src/Famix-Java-Entities/FamixJavaPackage.class.st +++ b/src/Famix-Java-Entities/FamixJavaPackage.class.st @@ -3,20 +3,29 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| + ### Children -- Relation: #childEntities Type: #FamixTPackageable Opposite: #parentPackage +| Relation | Origin | Opposite | Type | Comment | +| `childEntities` | `FamixTPackage` | `parentPackage` | `FamixTPackageable` | | + ### Incoming dependencies -- Relation: #incomingImports Type: #FamixTImport Opposite: #importedEntity Comment: List of imports of this entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaParameter.class.st b/src/Famix-Java-Entities/FamixJavaParameter.class.st index 941ff906..af13e1b7 100644 --- a/src/Famix-Java-Entities/FamixJavaParameter.class.st +++ b/src/Famix-Java-Entities/FamixJavaParameter.class.st @@ -3,20 +3,27 @@ ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithParameters Opposite: #parameters Comment: Behavioural entity containing this parameter. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTParameter` | `parameters` | `FamixTWithParameters` | Behavioural entity containing this parameter. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isFinal Type: Boolean Comment: Entity can be declared final -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isFinal` | `Boolean` | false | Entity can be declared final| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaParameterizableClass.class.st b/src/Famix-Java-Entities/FamixJavaParameterizableClass.class.st index 0b17d971..e1040b33 100644 --- a/src/Famix-Java-Entities/FamixJavaParameterizableClass.class.st +++ b/src/Famix-Java-Entities/FamixJavaParameterizableClass.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #parameterizedTypes Type: #FamixTParameterizedType Opposite: #parameterizableClass +| Relation | Origin | Opposite | Type | Comment | +| `parameterizedTypes` | `FamixTWithParameterizedTypes` | `parameterizableClass` | `FamixTParameterizedType` | | + " diff --git a/src/Famix-Java-Entities/FamixJavaParameterizableException.class.st b/src/Famix-Java-Entities/FamixJavaParameterizableException.class.st index dde60a6c..3477396c 100644 --- a/src/Famix-Java-Entities/FamixJavaParameterizableException.class.st +++ b/src/Famix-Java-Entities/FamixJavaParameterizableException.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #parameterizedTypes Type: #FamixTParameterizedType Opposite: #parameterizableClass +| Relation | Origin | Opposite | Type | Comment | +| `parameterizedTypes` | `FamixTWithParameterizedTypes` | `parameterizableClass` | `FamixTParameterizedType` | | + " diff --git a/src/Famix-Java-Entities/FamixJavaParameterizableInterface.class.st b/src/Famix-Java-Entities/FamixJavaParameterizableInterface.class.st index 220738be..f26d661f 100644 --- a/src/Famix-Java-Entities/FamixJavaParameterizableInterface.class.st +++ b/src/Famix-Java-Entities/FamixJavaParameterizableInterface.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #parameterizedTypes Type: #FamixTParameterizedType Opposite: #parameterizableClass +| Relation | Origin | Opposite | Type | Comment | +| `parameterizedTypes` | `FamixTWithParameterizedTypes` | `parameterizableClass` | `FamixTParameterizedType` | | + " diff --git a/src/Famix-Java-Entities/FamixJavaParameterizedType.class.st b/src/Famix-Java-Entities/FamixJavaParameterizedType.class.st index 056bfb7a..9528beae 100644 --- a/src/Famix-Java-Entities/FamixJavaParameterizedType.class.st +++ b/src/Famix-Java-Entities/FamixJavaParameterizedType.class.st @@ -3,14 +3,20 @@ ====================== ### Outgoing dependencies -- Relation: #interfaceImplementations Type: #FamixTImplementation Opposite: #implementingClass Comment: Implementation relationships -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `interfaceImplementations` | `FamixTCanImplement` | `implementingClass` | `FamixTImplementation` | Implementation relationships| +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #implementations Type: #FamixTImplementation Opposite: #interface Comment: Implementation relationships. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `implementations` | `FamixTImplementable` | `interface` | `FamixTImplementation` | Implementation relationships.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #arguments Type: #FamixTParameterizedTypeUser Opposite: #argumentsInParameterizedTypes -- Relation: #parameterizableClass Type: #FamixTWithParameterizedTypes Opposite: #parameterizedTypes Comment: Base type of this parameterized type. +| Relation | Origin | Opposite | Type | Comment | +| `arguments` | `FamixTWithParameterizedTypeUsers` | `argumentsInParameterizedTypes` | `FamixTParameterizedTypeUser` | | +| `parameterizableClass` | `FamixTParameterizedType` | `parameterizedTypes` | `FamixTWithParameterizedTypes` | Base type of this parameterized type.| + " diff --git a/src/Famix-Java-Entities/FamixJavaPrimitiveType.class.st b/src/Famix-Java-Entities/FamixJavaPrimitiveType.class.st index 0744de4f..bce2076f 100644 --- a/src/Famix-Java-Entities/FamixJavaPrimitiveType.class.st +++ b/src/Famix-Java-Entities/FamixJavaPrimitiveType.class.st @@ -3,18 +3,25 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaReference.class.st b/src/Famix-Java-Entities/FamixJavaReference.class.st index d681e6c4..09106590 100644 --- a/src/Famix-Java-Entities/FamixJavaReference.class.st +++ b/src/Famix-Java-Entities/FamixJavaReference.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #referencer Type: #FamixTWithReferences Opposite: #outgoingReferences Comment: Source entity making the reference. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referencer` | `FamixTReference` | `outgoingReferences` | `FamixTWithReferences` | Source entity making the reference. from-side of the association| + ### Association target -- Relation: #referredType Type: #FamixTReferenceable Opposite: #incomingReferences Comment: Target entity referenced. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referredType` | `FamixTReference` | `incomingReferences` | `FamixTReferenceable` | Target entity referenced. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaSourceAnchor.class.st b/src/Famix-Java-Entities/FamixJavaSourceAnchor.class.st index 8f9473ea..42934521 100644 --- a/src/Famix-Java-Entities/FamixJavaSourceAnchor.class.st +++ b/src/Famix-Java-Entities/FamixJavaSourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Java-Entities/FamixJavaSourceLanguage.class.st b/src/Famix-Java-Entities/FamixJavaSourceLanguage.class.st index b361a4bc..76d4c365 100644 --- a/src/Famix-Java-Entities/FamixJavaSourceLanguage.class.st +++ b/src/Famix-Java-Entities/FamixJavaSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Java-Entities/FamixJavaSourceTextAnchor.class.st b/src/Famix-Java-Entities/FamixJavaSourceTextAnchor.class.st index e317e90d..47500461 100644 --- a/src/Famix-Java-Entities/FamixJavaSourceTextAnchor.class.st +++ b/src/Famix-Java-Entities/FamixJavaSourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaSourcedEntity.class.st b/src/Famix-Java-Entities/FamixJavaSourcedEntity.class.st index 56b1a5c3..8ed63587 100644 --- a/src/Famix-Java-Entities/FamixJavaSourcedEntity.class.st +++ b/src/Famix-Java-Entities/FamixJavaSourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaTCanBeSynchronized.trait.st b/src/Famix-Java-Entities/FamixJavaTCanBeSynchronized.trait.st index 7ead2183..4f5e37ac 100644 --- a/src/Famix-Java-Entities/FamixJavaTCanBeSynchronized.trait.st +++ b/src/Famix-Java-Entities/FamixJavaTCanBeSynchronized.trait.st @@ -15,7 +15,8 @@ public class SynchronizedCounter { ## Properties ====================== -- Named: #isSynchronized Type: Boolean Comment: Entity can be declared synchronized +| Name | Type | Default value | Comment | +| `isSynchronized` | `Boolean` | false | Entity can be declared synchronized| " Trait { diff --git a/src/Famix-Java-Entities/FamixJavaTCanBeTransient.trait.st b/src/Famix-Java-Entities/FamixJavaTCanBeTransient.trait.st index 2d8f7980..60b8b343 100644 --- a/src/Famix-Java-Entities/FamixJavaTCanBeTransient.trait.st +++ b/src/Famix-Java-Entities/FamixJavaTCanBeTransient.trait.st @@ -11,7 +11,8 @@ public class Student implements Serializable{ ## Properties ====================== -- Named: #isTransient Type: Boolean Comment: Entity can be declared transient +| Name | Type | Default value | Comment | +| `isTransient` | `Boolean` | false | Entity can be declared transient| " Trait { diff --git a/src/Famix-Java-Entities/FamixJavaTCanBeVolatile.trait.st b/src/Famix-Java-Entities/FamixJavaTCanBeVolatile.trait.st index 5fbab043..b13eb1f1 100644 --- a/src/Famix-Java-Entities/FamixJavaTCanBeVolatile.trait.st +++ b/src/Famix-Java-Entities/FamixJavaTCanBeVolatile.trait.st @@ -11,7 +11,8 @@ public class SharedObject { ## Properties ====================== -- Named: #isVolatile Type: Boolean Comment: Entity can be declared volatile +| Name | Type | Default value | Comment | +| `isVolatile` | `Boolean` | false | Entity can be declared volatile| " Trait { diff --git a/src/Famix-Java-Entities/FamixJavaTWithInterfaces.trait.st b/src/Famix-Java-Entities/FamixJavaTWithInterfaces.trait.st index f6d7eac0..e672a4ab 100644 --- a/src/Famix-Java-Entities/FamixJavaTWithInterfaces.trait.st +++ b/src/Famix-Java-Entities/FamixJavaTWithInterfaces.trait.st @@ -5,8 +5,10 @@ I can contain interfaces (Packages, Methods, Classes...) ====================== ### Children -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + " diff --git a/src/Famix-Java-Entities/FamixJavaType.class.st b/src/Famix-Java-Entities/FamixJavaType.class.st index 7dd2e0dd..9fce5eea 100644 --- a/src/Famix-Java-Entities/FamixJavaType.class.st +++ b/src/Famix-Java-Entities/FamixJavaType.class.st @@ -3,21 +3,30 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #argumentsInParameterizedTypes Type: #FamixTWithParameterizedTypeUsers Opposite: #arguments -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `argumentsInParameterizedTypes` | `FamixTParameterizedTypeUser` | `arguments` | `FamixTWithParameterizedTypeUsers` | | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Java-Entities/FamixJavaUnknownSourceLanguage.class.st b/src/Famix-Java-Entities/FamixJavaUnknownSourceLanguage.class.st index f849670a..38e82e92 100644 --- a/src/Famix-Java-Entities/FamixJavaUnknownSourceLanguage.class.st +++ b/src/Famix-Java-Entities/FamixJavaUnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Java-Entities/FamixJavaUnknownVariable.class.st b/src/Famix-Java-Entities/FamixJavaUnknownVariable.class.st index bf0e72da..6b6c02f1 100644 --- a/src/Famix-Java-Entities/FamixJavaUnknownVariable.class.st +++ b/src/Famix-Java-Entities/FamixJavaUnknownVariable.class.st @@ -3,17 +3,22 @@ ====================== ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-MetamodelBuilder-Core/FmxMBBehavior.class.st b/src/Famix-MetamodelBuilder-Core/FmxMBBehavior.class.st index a4f3568f..19359ffc 100644 --- a/src/Famix-MetamodelBuilder-Core/FmxMBBehavior.class.st +++ b/src/Famix-MetamodelBuilder-Core/FmxMBBehavior.class.st @@ -146,26 +146,28 @@ FmxMBBehavior >> commentWithRelations [ aStream nextPutAll: '### '; nextPutAll: relationKind; + cr; + nextPutAll: '| Relation | Origin | Opposite | Type | Comment |'; cr. - (parents sorted: [ :parent | parent side generationStrategy relationSide name ] ascending) do: [ :parent | | strategy | strategy := parent side generationStrategy. aStream - nextPutAll: '- Relation: #'; + nextPutAll: '| `'; nextPutAll: strategy relationSide name; - nextPutAll: ' Type: #'; + nextPutAll: '` | `'; + nextPutAll: strategy relationSide type; + nextPutAll: '` | `'; + nextPutAll: strategy relationSide oppositeName; + nextPutAll: '` | `'; nextPutAll: strategy relationSide oppositeType; - nextPutAll: ' Opposite: #'; - nextPutAll: strategy relationSide oppositeName. - - strategy relationSide comment ifNotEmpty: [ :com | - aStream - nextPutAll: ' Comment: '; - nextPutAll: com ]. + nextPutAll: '` | '; + nextPutAll: strategy relationSide comment; + nextPut: $|; + cr ]. - aStream cr ] ] ]. + aStream cr ] ]. aStream cr ]. (self allProperties reject: [ :p | p isRelation ]) ifNotEmpty: [ :props | @@ -173,20 +175,22 @@ FmxMBBehavior >> commentWithRelations [ nextPutAll: '## Properties ======================'; cr; + cr; + nextPutAll: '| Name | Type | Default value | Comment |'; cr. (props sorted: #name ascending) do: [ :property | aStream - nextPutAll: '- Named: #'; + nextPutAll: '| `'; nextPutAll: property name; - nextPutAll: ' Type: '; - nextPutAll: property propertyType. - - property comment ifNotEmpty: [ :com | - aStream - nextPutAll: ' Comment: '; - nextPutAll: com ]. - aStream cr ] ] ] + nextPutAll: '` | `'; + nextPutAll: property propertyType; + nextPutAll: '` | '; + print: property defaultValue; + nextPutAll: ' | '; + nextPutAll: property comment; + nextPut: $|; + cr ] ] ] ] { #category : #'settings - default' } diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStAccess.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStAccess.class.st index 98deb8bc..35f7cae1 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStAccess.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStAccess.class.st @@ -3,19 +3,26 @@ ====================== ### Association source -- Relation: #accessor Type: #FamixTWithAccesses Opposite: #accesses Comment: Behavioural entity making the access to the variable. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `accessor` | `FamixTAccess` | `accesses` | `FamixTWithAccesses` | Behavioural entity making the access to the variable. from-side of the association| + ### Association target -- Relation: #variable Type: #FamixTAccessible Opposite: #incomingAccesses Comment: Variable accessed. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `variable` | `FamixTAccess` | `incomingAccesses` | `FamixTAccessible` | Variable accessed. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #isWrite Type: Boolean Comment: Write access +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `isWrite` | `Boolean` | false | Write access| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstance.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstance.class.st index 2c3aad07..8c1151a1 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstance.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstance.class.st @@ -3,10 +3,14 @@ ====================== ### Children -- Relation: #attributes Type: #FamixTAnnotationInstanceAttribute Opposite: #parentAnnotationInstance Comment: This corresponds to the actual values of the attributes in an AnnotationInstance +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAnnotationInstanceAttributes` | `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | This corresponds to the actual values of the attributes in an AnnotationInstance| + ### Other -- Relation: #annotatedEntity Type: #FamixTWithAnnotationInstances Opposite: #annotationInstances Comment: The NamedEntity on which the annotation occurs. -- Relation: #annotationType Type: #FamixTAnnotationType Opposite: #instances Comment: Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). +| Relation | Origin | Opposite | Type | Comment | +| `annotatedEntity` | `FamixTAnnotationInstance` | `annotationInstances` | `FamixTWithAnnotationInstances` | The NamedEntity on which the annotation occurs.| +| `annotationType` | `FamixTTypedAnnotationInstance` | `instances` | `FamixTAnnotationType` | Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). | + " diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstanceAttribute.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstanceAttribute.class.st index 42158ac2..a325f890 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstanceAttribute.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationInstanceAttribute.class.st @@ -3,14 +3,19 @@ ====================== ### Parents -- Relation: #parentAnnotationInstance Type: #FamixTWithAnnotationInstanceAttributes Opposite: #attributes Comment: The instance of the annotation in which the attribute is used. +| Relation | Origin | Opposite | Type | Comment | +| `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | `attributes` | `FamixTWithAnnotationInstanceAttributes` | The instance of the annotation in which the attribute is used.| + ### Other -- Relation: #annotationTypeAttribute Type: #FamixTAnnotationTypeAttribute Opposite: #annotationAttributeInstances Comment: This corresponds to the type of the attribute in an AnnotationInstance +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance| + ## Properties ====================== -- Named: #value Type: String Comment: Actual value of the attribute used in an annotation +| Name | Type | Default value | Comment | +| `value` | `String` | nil | Actual value of the attribute used in an annotation| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationType.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationType.class.st index 90ec8c1f..bd54aad5 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationType.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationType.class.st @@ -3,12 +3,18 @@ ====================== ### Parents -- Relation: #annotationTypesContainer Type: #FamixTWithAnnotationTypes Opposite: #definedAnnotationTypes Comment: Container in which an AnnotationType may reside -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypesContainer` | `FamixTAnnotationType` | `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | Container in which an AnnotationType may reside| +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| + ### Other -- Relation: #instances Type: #FamixTTypedAnnotationInstance Opposite: #annotationType Comment: Annotations of this type +| Relation | Origin | Opposite | Type | Comment | +| `instances` | `FamixTAnnotationType` | `annotationType` | `FamixTTypedAnnotationInstance` | Annotations of this type| + " diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationTypeAttribute.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationTypeAttribute.class.st index 70ddeb9c..da1d75f2 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationTypeAttribute.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStAnnotationTypeAttribute.class.st @@ -3,20 +3,27 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #annotationAttributeInstances Type: #FamixTTypedAnnotationInstanceAttribute Opposite: #annotationTypeAttribute Comment: A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances -- Relation: #annotationTypeAttribute Type: #FamixTAnnotationTypeAttribute Opposite: #annotationAttributeInstances Comment: This corresponds to the type of the attribute in an AnnotationInstance -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances| +| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStAttribute.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStAttribute.class.st index 224b673b..6fb83215 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStAttribute.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStAttribute.class.st @@ -3,20 +3,27 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStClass.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStClass.class.st index c88ea9b8..66745206 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStClass.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStClass.class.st @@ -3,28 +3,39 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isAbstract Type: Boolean Comment: Entity can be declared abstract -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isAbstract` | `Boolean` | false | Entity can be declared abstract| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStComment.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStComment.class.st index 056b699d..ef1af9f3 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStComment.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStComment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStGlobalVariable.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStGlobalVariable.class.st index 07145086..4318cea2 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStGlobalVariable.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStGlobalVariable.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentScope Type: #FamixTWithGlobalVariables Opposite: #globalVariables Comment: Scope declaring the global variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentScope` | `FamixTGlobalVariable` | `globalVariables` | `FamixTWithGlobalVariables` | Scope declaring the global variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStImplicitVariable.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStImplicitVariable.class.st index ab33ce11..952663d6 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStImplicitVariable.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStImplicitVariable.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithImplicitVariables Opposite: #implicitVariables Comment: The behaviour containing this implicit variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTImplicitVariable` | `implicitVariables` | `FamixTWithImplicitVariables` | The behaviour containing this implicit variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStInheritance.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStInheritance.class.st index 89de316c..02188bff 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStInheritance.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStInheritance.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #subclass Type: #FamixTWithInheritances Opposite: #superInheritances Comment: Subclass linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `subclass` | `FamixTInheritance` | `superInheritances` | `FamixTWithInheritances` | Subclass linked to in this relationship. from-side of the association| + ### Association target -- Relation: #superclass Type: #FamixTWithInheritances Opposite: #subInheritances Comment: Superclass linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `superclass` | `FamixTInheritance` | `subInheritances` | `FamixTWithInheritances` | Superclass linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStInvocation.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStInvocation.class.st index 04325199..c48a5dc1 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStInvocation.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStInvocation.class.st @@ -3,20 +3,27 @@ ====================== ### Association source -- Relation: #sender Type: #FamixTWithInvocations Opposite: #outgoingInvocations Comment: Behavioural entity making the call. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `sender` | `FamixTInvocation` | `outgoingInvocations` | `FamixTWithInvocations` | Behavioural entity making the call. from-side of the association| + ### Association target -- Relation: #candidates Type: #FamixTInvocable Opposite: #incomingInvocations Comment: List of candidate behavioural entities for receiving the invocation +| Relation | Origin | Opposite | Type | Comment | +| `candidates` | `FamixTInvocation` | `incomingInvocations` | `FamixTInvocable` | List of candidate behavioural entities for receiving the invocation| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #receiver Type: #FamixTInvocationsReceiver Opposite: #receivingInvocations Comment: Named entity (variable, class...) receiving the invocation. to-side of the association -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `receiver` | `FamixTInvocation` | `receivingInvocations` | `FamixTInvocationsReceiver` | Named entity (variable, class...) receiving the invocation. to-side of the association| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStLocalVariable.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStLocalVariable.class.st index b107907a..46083f6c 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStLocalVariable.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStLocalVariable.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithLocalVariables Opposite: #localVariables Comment: Behavioural entity declaring this local variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTLocalVariable` | `localVariables` | `FamixTWithLocalVariables` | Behavioural entity declaring this local variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStMethod.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStMethod.class.st index bc551fff..da5cc7b8 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStMethod.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStMethod.class.st @@ -3,35 +3,46 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #definedAnnotationTypes Type: #FamixTAnnotationType Opposite: #annotationTypesContainer Comment: The container in which the AnnotationTypes may be declared -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | `annotationTypesContainer` | `FamixTAnnotationType` | The container in which the AnnotationTypes may be declared| +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #annotationInstances Type: #FamixTAnnotationInstance Opposite: #annotatedEntity Comment: This property corresponds to the set of annotations associated to the entity -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `annotationInstances` | `FamixTWithAnnotationInstances` | `annotatedEntity` | `FamixTAnnotationInstance` | This property corresponds to the set of annotations associated to the entity| +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isAbstract Type: Boolean Comment: Entity can be declared abstract -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #kind Type: String Comment: Tag indicating a setter, getter, constant, constructor method -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #protocol Type: String Comment: Protocol of the method -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isAbstract` | `Boolean` | false | Entity can be declared abstract| +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `kind` | `String` | nil | Tag indicating a setter, getter, constant, constructor method| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `protocol` | `String` | nil | Protocol of the method| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStNamedEntity.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStNamedEntity.class.st index 9381307a..0314794d 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStNamedEntity.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStNamedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) +| Relation | Origin | Opposite | Type | Comment | +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| + ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStNamespace.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStNamespace.class.st index a76be723..534b8f92 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStNamespace.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStNamespace.class.st @@ -3,18 +3,23 @@ ====================== ### Children -- Relation: #globalVariables Type: #FamixTGlobalVariable Opposite: #parentScope Comment: Global variables defined in the scope, if any. -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `globalVariables` | `FamixTWithGlobalVariables` | `parentScope` | `FamixTGlobalVariable` | Global variables defined in the scope, if any.| +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + ### Other -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStPackage.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStPackage.class.st index 7f8dc012..eaa68c24 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStPackage.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStPackage.class.st @@ -3,18 +3,23 @@ ====================== ### Children -- Relation: #childEntities Type: #FamixTPackageable Opposite: #parentPackage -- Relation: #globalVariables Type: #FamixTGlobalVariable Opposite: #parentScope Comment: Global variables defined in the scope, if any. -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `childEntities` | `FamixTPackage` | `parentPackage` | `FamixTPackageable` | | +| `globalVariables` | `FamixTWithGlobalVariables` | `parentScope` | `FamixTGlobalVariable` | Global variables defined in the scope, if any.| +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStParameter.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStParameter.class.st index 0840f25a..727b7721 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStParameter.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStParameter.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithParameters Opposite: #parameters Comment: Behavioural entity containing this parameter. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTParameter` | `parameters` | `FamixTWithParameters` | Behavioural entity containing this parameter. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStPharoEntitySourceAnchor.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStPharoEntitySourceAnchor.class.st index 21e11121..a711c921 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStPharoEntitySourceAnchor.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStPharoEntitySourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStReference.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStReference.class.st index 38dc3920..98aab0be 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStReference.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStReference.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #referencer Type: #FamixTWithReferences Opposite: #outgoingReferences Comment: Source entity making the reference. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referencer` | `FamixTReference` | `outgoingReferences` | `FamixTWithReferences` | Source entity making the reference. from-side of the association| + ### Association target -- Relation: #referredType Type: #FamixTReferenceable Opposite: #incomingReferences Comment: Target entity referenced. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referredType` | `FamixTReference` | `incomingReferences` | `FamixTReferenceable` | Target entity referenced. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStSourceAnchor.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStSourceAnchor.class.st index 3f3ebfdb..07136c81 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStSourceAnchor.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStSourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStSourceLanguage.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStSourceLanguage.class.st index f446de60..166323f5 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStSourceLanguage.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStSourceTextAnchor.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStSourceTextAnchor.class.st index a5a80d15..04be45cf 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStSourceTextAnchor.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStSourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStSourcedEntity.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStSourcedEntity.class.st index 2b55392b..d86655f7 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStSourcedEntity.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStSourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStUnknownSourceLanguage.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStUnknownSourceLanguage.class.st index 834ed1a3..3c0a8633 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStUnknownSourceLanguage.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStUnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-PharoSmalltalk-Entities/FamixStUnknownVariable.class.st b/src/Famix-PharoSmalltalk-Entities/FamixStUnknownVariable.class.st index c5ba8bfc..b317c7ec 100644 --- a/src/Famix-PharoSmalltalk-Entities/FamixStUnknownVariable.class.st +++ b/src/Famix-PharoSmalltalk-Entities/FamixStUnknownVariable.class.st @@ -3,17 +3,22 @@ ====================== ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Association.class.st b/src/Famix-Test1-Entities/FamixTest1Association.class.st index 637f4625..52a83017 100644 --- a/src/Famix-Test1-Entities/FamixTest1Association.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Association.class.st @@ -3,14 +3,17 @@ ====================== ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Attribute.class.st b/src/Famix-Test1-Entities/FamixTest1Attribute.class.st index 610f7225..533968c7 100644 --- a/src/Famix-Test1-Entities/FamixTest1Attribute.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Attribute.class.st @@ -3,20 +3,27 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredSourceLanguage Type: #FamixTSourceLanguage Opposite: #sourcedEntities Comment: The declared SourceLanguage for the source code of this entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredSourceLanguage` | `FamixTWithSourceLanguages` | `sourcedEntities` | `FamixTSourceLanguage` | The declared SourceLanguage for the source code of this entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | nil | Entity can be declared class side i.e. static| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Class.class.st b/src/Famix-Test1-Entities/FamixTest1Class.class.st index 22473348..e8676f4a 100644 --- a/src/Famix-Test1-Entities/FamixTest1Class.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Class.class.st @@ -5,28 +5,39 @@ This a comment for the Class entity ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredSourceLanguage Type: #FamixTSourceLanguage Opposite: #sourcedEntities Comment: The declared SourceLanguage for the source code of this entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredSourceLanguage` | `FamixTWithSourceLanguages` | `sourcedEntities` | `FamixTSourceLanguage` | The declared SourceLanguage for the source code of this entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Comment.class.st b/src/Famix-Test1-Entities/FamixTest1Comment.class.st index 75692fe5..120a83b2 100644 --- a/src/Famix-Test1-Entities/FamixTest1Comment.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1File.class.st b/src/Famix-Test1-Entities/FamixTest1File.class.st index 4d4c92f7..8357b315 100644 --- a/src/Famix-Test1-Entities/FamixTest1File.class.st +++ b/src/Famix-Test1-Entities/FamixTest1File.class.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + ### Other -- Relation: #entities Type: #FamixTWithFiles Opposite: #containerFiles Comment: List of entities defined in the file +| Relation | Origin | Opposite | Type | Comment | +| `entities` | `FamixTFile` | `containerFiles` | `FamixTWithFiles` | List of entities defined in the file| + " diff --git a/src/Famix-Test1-Entities/FamixTest1FileAnchor.class.st b/src/Famix-Test1-Entities/FamixTest1FileAnchor.class.st index b7fc750a..8b1540cc 100644 --- a/src/Famix-Test1-Entities/FamixTest1FileAnchor.class.st +++ b/src/Famix-Test1-Entities/FamixTest1FileAnchor.class.st @@ -2,13 +2,14 @@ ## Properties ====================== -- Named: #correspondingFile Type: FamixTFile Comment: File associated to this source anchor -- Named: #encoding Type: String Comment: A string representing the encoding of a file -- Named: #endColumn Type: Number Comment: Number of the end column -- Named: #endLine Type: Number Comment: Number of the end line -- Named: #fileName Type: String Comment: Name of the source file -- Named: #startColumn Type: Number Comment: Number of the start column -- Named: #startLine Type: Number Comment: Number of the start line +| Name | Type | Default value | Comment | +| `correspondingFile` | `FamixTFile` | nil | File associated to this source anchor| +| `encoding` | `String` | nil | A string representing the encoding of a file| +| `endColumn` | `Number` | nil | Number of the end column| +| `endLine` | `Number` | nil | Number of the end line| +| `fileName` | `String` | nil | Name of the source file| +| `startColumn` | `Number` | nil | Number of the start column| +| `startLine` | `Number` | nil | Number of the start line| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Folder.class.st b/src/Famix-Test1-Entities/FamixTest1Folder.class.st index 7578fefe..4b1a7490 100644 --- a/src/Famix-Test1-Entities/FamixTest1Folder.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Folder.class.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + ### Children -- Relation: #childrenFileSystemEntities Type: #FamixTFileSystemEntity Opposite: #parentFolder Comment: List of entities contained in this folder. +| Relation | Origin | Opposite | Type | Comment | +| `childrenFileSystemEntities` | `FamixTFolder` | `parentFolder` | `FamixTFileSystemEntity` | List of entities contained in this folder.| + " diff --git a/src/Famix-Test1-Entities/FamixTest1IndexedFileAnchor.class.st b/src/Famix-Test1-Entities/FamixTest1IndexedFileAnchor.class.st index 79ada6fe..fa5969b0 100644 --- a/src/Famix-Test1-Entities/FamixTest1IndexedFileAnchor.class.st +++ b/src/Famix-Test1-Entities/FamixTest1IndexedFileAnchor.class.st @@ -2,11 +2,12 @@ ## Properties ====================== -- Named: #correspondingFile Type: FamixTFile Comment: File associated to this source anchor -- Named: #encoding Type: String Comment: A string representing the encoding of a file -- Named: #endPos Type: Number Comment: Stop position in the source -- Named: #fileName Type: String Comment: Name of the source file -- Named: #startPos Type: Number Comment: Start position in the source +| Name | Type | Default value | Comment | +| `correspondingFile` | `FamixTFile` | nil | File associated to this source anchor| +| `encoding` | `String` | nil | A string representing the encoding of a file| +| `endPos` | `Number` | nil | Stop position in the source| +| `fileName` | `String` | nil | Name of the source file| +| `startPos` | `Number` | nil | Start position in the source| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Method.class.st b/src/Famix-Test1-Entities/FamixTest1Method.class.st index 088eb335..d2048291 100644 --- a/src/Famix-Test1-Entities/FamixTest1Method.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Method.class.st @@ -3,31 +3,42 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaredSourceLanguage Type: #FamixTSourceLanguage Opposite: #sourcedEntities Comment: The declared SourceLanguage for the source code of this entity -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaredSourceLanguage` | `FamixTWithSourceLanguages` | `sourcedEntities` | `FamixTSourceLanguage` | The declared SourceLanguage for the source code of this entity| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #kind Type: String Comment: Tag indicating a setter, getter, constant, constructor method -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | nil | Entity can be declared class side i.e. static| +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `kind` | `String` | nil | Tag indicating a setter, getter, constant, constructor method| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1Model.class.st b/src/Famix-Test1-Entities/FamixTest1Model.class.st index acf41bd9..13839f38 100644 --- a/src/Famix-Test1-Entities/FamixTest1Model.class.st +++ b/src/Famix-Test1-Entities/FamixTest1Model.class.st @@ -4,7 +4,8 @@ This is a the comment of the model class ## Properties ====================== -- Named: #modelHasProperties Type: Object +| Name | Type | Default value | Comment | +| `modelHasProperties` | `Object` | nil | | " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1MultipleFileAnchor.class.st b/src/Famix-Test1-Entities/FamixTest1MultipleFileAnchor.class.st index 1d450528..5d1da9f3 100644 --- a/src/Famix-Test1-Entities/FamixTest1MultipleFileAnchor.class.st +++ b/src/Famix-Test1-Entities/FamixTest1MultipleFileAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #fileAnchors Type: FamixTFileAnchor Comment: All source code definition files +| Name | Type | Default value | Comment | +| `fileAnchors` | `FamixTFileAnchor` | nil | All source code definition files| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1NamedEntity.class.st b/src/Famix-Test1-Entities/FamixTest1NamedEntity.class.st index 5cea64d2..bf525e9d 100644 --- a/src/Famix-Test1-Entities/FamixTest1NamedEntity.class.st +++ b/src/Famix-Test1-Entities/FamixTest1NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1SourceAnchor.class.st b/src/Famix-Test1-Entities/FamixTest1SourceAnchor.class.st index deb30429..2c4ce352 100644 --- a/src/Famix-Test1-Entities/FamixTest1SourceAnchor.class.st +++ b/src/Famix-Test1-Entities/FamixTest1SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Test1-Entities/FamixTest1SourceLanguage.class.st b/src/Famix-Test1-Entities/FamixTest1SourceLanguage.class.st index 7438243b..5b2f161a 100644 --- a/src/Famix-Test1-Entities/FamixTest1SourceLanguage.class.st +++ b/src/Famix-Test1-Entities/FamixTest1SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test1-Entities/FamixTest1SourceTextAnchor.class.st b/src/Famix-Test1-Entities/FamixTest1SourceTextAnchor.class.st index 14741f43..09d8c208 100644 --- a/src/Famix-Test1-Entities/FamixTest1SourceTextAnchor.class.st +++ b/src/Famix-Test1-Entities/FamixTest1SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1SourcedEntity.class.st b/src/Famix-Test1-Entities/FamixTest1SourcedEntity.class.st index 7dd7c946..bfa37322 100644 --- a/src/Famix-Test1-Entities/FamixTest1SourcedEntity.class.st +++ b/src/Famix-Test1-Entities/FamixTest1SourcedEntity.class.st @@ -3,14 +3,17 @@ ====================== ### Other -- Relation: #containerFiles Type: #FamixTFile Opposite: #entities Comment: List of files containing the entity -- Relation: #declaredSourceLanguage Type: #FamixTSourceLanguage Opposite: #sourcedEntities Comment: The declared SourceLanguage for the source code of this entity -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `containerFiles` | `FamixTWithFiles` | `entities` | `FamixTFile` | List of files containing the entity| +| `declaredSourceLanguage` | `FamixTWithSourceLanguages` | `sourcedEntities` | `FamixTSourceLanguage` | The declared SourceLanguage for the source code of this entity| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test1-Entities/FamixTest1TCanBeClassSide.trait.st b/src/Famix-Test1-Entities/FamixTest1TCanBeClassSide.trait.st index c2d08ae0..2d0ec612 100644 --- a/src/Famix-Test1-Entities/FamixTest1TCanBeClassSide.trait.st +++ b/src/Famix-Test1-Entities/FamixTest1TCanBeClassSide.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | nil | Entity can be declared class side i.e. static| " Trait { diff --git a/src/Famix-Test1-Entities/FamixTest1UnknownSourceLanguage.class.st b/src/Famix-Test1-Entities/FamixTest1UnknownSourceLanguage.class.st index f2b2366e..28f94b77 100644 --- a/src/Famix-Test1-Entities/FamixTest1UnknownSourceLanguage.class.st +++ b/src/Famix-Test1-Entities/FamixTest1UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test2-Entities/FamixTest2Class.class.st b/src/Famix-Test2-Entities/FamixTest2Class.class.st index 8e1aca06..474f396b 100644 --- a/src/Famix-Test2-Entities/FamixTest2Class.class.st +++ b/src/Famix-Test2-Entities/FamixTest2Class.class.st @@ -3,26 +3,37 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test2-Entities/FamixTest2Comment.class.st b/src/Famix-Test2-Entities/FamixTest2Comment.class.st index 378e78a8..826ca822 100644 --- a/src/Famix-Test2-Entities/FamixTest2Comment.class.st +++ b/src/Famix-Test2-Entities/FamixTest2Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-Test2-Entities/FamixTest2Inheritance.class.st b/src/Famix-Test2-Entities/FamixTest2Inheritance.class.st index d1043e1c..61279929 100644 --- a/src/Famix-Test2-Entities/FamixTest2Inheritance.class.st +++ b/src/Famix-Test2-Entities/FamixTest2Inheritance.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #subclass Type: #FamixTWithInheritances Opposite: #superInheritances Comment: Subclass linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `subclass` | `FamixTInheritance` | `superInheritances` | `FamixTWithInheritances` | Subclass linked to in this relationship. from-side of the association| + ### Association target -- Relation: #superclass Type: #FamixTWithInheritances Opposite: #subInheritances Comment: Superclass linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `superclass` | `FamixTInheritance` | `subInheritances` | `FamixTWithInheritances` | Superclass linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test2-Entities/FamixTest2NamedEntity.class.st b/src/Famix-Test2-Entities/FamixTest2NamedEntity.class.st index 8249f881..cdbee27e 100644 --- a/src/Famix-Test2-Entities/FamixTest2NamedEntity.class.st +++ b/src/Famix-Test2-Entities/FamixTest2NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test2-Entities/FamixTest2SourceAnchor.class.st b/src/Famix-Test2-Entities/FamixTest2SourceAnchor.class.st index e2a08d88..ae59e557 100644 --- a/src/Famix-Test2-Entities/FamixTest2SourceAnchor.class.st +++ b/src/Famix-Test2-Entities/FamixTest2SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Test2-Entities/FamixTest2SourceLanguage.class.st b/src/Famix-Test2-Entities/FamixTest2SourceLanguage.class.st index 8c840362..fe538c81 100644 --- a/src/Famix-Test2-Entities/FamixTest2SourceLanguage.class.st +++ b/src/Famix-Test2-Entities/FamixTest2SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test2-Entities/FamixTest2SourceTextAnchor.class.st b/src/Famix-Test2-Entities/FamixTest2SourceTextAnchor.class.st index 5b7ea368..f85e0e67 100644 --- a/src/Famix-Test2-Entities/FamixTest2SourceTextAnchor.class.st +++ b/src/Famix-Test2-Entities/FamixTest2SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-Test2-Entities/FamixTest2SourcedEntity.class.st b/src/Famix-Test2-Entities/FamixTest2SourcedEntity.class.st index 87600357..a4d21f7a 100644 --- a/src/Famix-Test2-Entities/FamixTest2SourcedEntity.class.st +++ b/src/Famix-Test2-Entities/FamixTest2SourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test2-Entities/FamixTest2UnknownSourceLanguage.class.st b/src/Famix-Test2-Entities/FamixTest2UnknownSourceLanguage.class.st index 0d1e7fdb..ee6e02a9 100644 --- a/src/Famix-Test2-Entities/FamixTest2UnknownSourceLanguage.class.st +++ b/src/Famix-Test2-Entities/FamixTest2UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test3-Entities/FamixTest3Access.class.st b/src/Famix-Test3-Entities/FamixTest3Access.class.st index dd89048c..11786a7b 100644 --- a/src/Famix-Test3-Entities/FamixTest3Access.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Access.class.st @@ -3,19 +3,26 @@ ====================== ### Association source -- Relation: #accessor Type: #FamixTWithAccesses Opposite: #accesses Comment: Behavioural entity making the access to the variable. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `accessor` | `FamixTAccess` | `accesses` | `FamixTWithAccesses` | Behavioural entity making the access to the variable. from-side of the association| + ### Association target -- Relation: #variable Type: #FamixTAccessible Opposite: #incomingAccesses Comment: Variable accessed. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `variable` | `FamixTAccess` | `incomingAccesses` | `FamixTAccessible` | Variable accessed. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #isWrite Type: Boolean Comment: Write access +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `isWrite` | `Boolean` | false | Write access| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Attribute.class.st b/src/Famix-Test3-Entities/FamixTest3Attribute.class.st index 7287615c..cdc2718f 100644 --- a/src/Famix-Test3-Entities/FamixTest3Attribute.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Attribute.class.st @@ -3,18 +3,25 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Class.class.st b/src/Famix-Test3-Entities/FamixTest3Class.class.st index f9b96897..fb0d8c3d 100644 --- a/src/Famix-Test3-Entities/FamixTest3Class.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Class.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Comment.class.st b/src/Famix-Test3-Entities/FamixTest3Comment.class.st index 028e8648..afb30b80 100644 --- a/src/Famix-Test3-Entities/FamixTest3Comment.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Invocation.class.st b/src/Famix-Test3-Entities/FamixTest3Invocation.class.st index a12d217a..f6c7214b 100644 --- a/src/Famix-Test3-Entities/FamixTest3Invocation.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Invocation.class.st @@ -3,20 +3,27 @@ ====================== ### Association source -- Relation: #sender Type: #FamixTWithInvocations Opposite: #outgoingInvocations Comment: Behavioural entity making the call. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `sender` | `FamixTInvocation` | `outgoingInvocations` | `FamixTWithInvocations` | Behavioural entity making the call. from-side of the association| + ### Association target -- Relation: #candidates Type: #FamixTInvocable Opposite: #incomingInvocations Comment: List of candidate behavioural entities for receiving the invocation +| Relation | Origin | Opposite | Type | Comment | +| `candidates` | `FamixTInvocation` | `incomingInvocations` | `FamixTInvocable` | List of candidate behavioural entities for receiving the invocation| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #receiver Type: #FamixTInvocationsReceiver Opposite: #receivingInvocations Comment: Named entity (variable, class...) receiving the invocation. to-side of the association -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `receiver` | `FamixTInvocation` | `receivingInvocations` | `FamixTInvocationsReceiver` | Named entity (variable, class...) receiving the invocation. to-side of the association| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Method.class.st b/src/Famix-Test3-Entities/FamixTest3Method.class.st index 609eecf6..c58fe3fb 100644 --- a/src/Famix-Test3-Entities/FamixTest3Method.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Method.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3NamedEntity.class.st b/src/Famix-Test3-Entities/FamixTest3NamedEntity.class.st index 9fce442f..2e27d8fe 100644 --- a/src/Famix-Test3-Entities/FamixTest3NamedEntity.class.st +++ b/src/Famix-Test3-Entities/FamixTest3NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Package.class.st b/src/Famix-Test3-Entities/FamixTest3Package.class.st index 9c7950ec..2932e1ba 100644 --- a/src/Famix-Test3-Entities/FamixTest3Package.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Package.class.st @@ -3,15 +3,20 @@ ====================== ### Children -- Relation: #childEntities Type: #FamixTPackageable Opposite: #parentPackage +| Relation | Origin | Opposite | Type | Comment | +| `childEntities` | `FamixTPackage` | `parentPackage` | `FamixTPackageable` | | + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3PrimitiveType.class.st b/src/Famix-Test3-Entities/FamixTest3PrimitiveType.class.st index 6d5eef7c..0a8f98bb 100644 --- a/src/Famix-Test3-Entities/FamixTest3PrimitiveType.class.st +++ b/src/Famix-Test3-Entities/FamixTest3PrimitiveType.class.st @@ -3,10 +3,14 @@ ====================== ### Children -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + " diff --git a/src/Famix-Test3-Entities/FamixTest3Reference.class.st b/src/Famix-Test3-Entities/FamixTest3Reference.class.st index 3c9c26ea..84a26cc5 100644 --- a/src/Famix-Test3-Entities/FamixTest3Reference.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Reference.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #referencer Type: #FamixTWithReferences Opposite: #outgoingReferences Comment: Source entity making the reference. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referencer` | `FamixTReference` | `outgoingReferences` | `FamixTWithReferences` | Source entity making the reference. from-side of the association| + ### Association target -- Relation: #referredType Type: #FamixTReferenceable Opposite: #incomingReferences Comment: Target entity referenced. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referredType` | `FamixTReference` | `incomingReferences` | `FamixTReferenceable` | Target entity referenced. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3SourceAnchor.class.st b/src/Famix-Test3-Entities/FamixTest3SourceAnchor.class.st index 8aa242a5..db0be1af 100644 --- a/src/Famix-Test3-Entities/FamixTest3SourceAnchor.class.st +++ b/src/Famix-Test3-Entities/FamixTest3SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Test3-Entities/FamixTest3SourceLanguage.class.st b/src/Famix-Test3-Entities/FamixTest3SourceLanguage.class.st index d3054666..3d1b1385 100644 --- a/src/Famix-Test3-Entities/FamixTest3SourceLanguage.class.st +++ b/src/Famix-Test3-Entities/FamixTest3SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test3-Entities/FamixTest3SourceTextAnchor.class.st b/src/Famix-Test3-Entities/FamixTest3SourceTextAnchor.class.st index 5946dda8..342b39ea 100644 --- a/src/Famix-Test3-Entities/FamixTest3SourceTextAnchor.class.st +++ b/src/Famix-Test3-Entities/FamixTest3SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3SourcedEntity.class.st b/src/Famix-Test3-Entities/FamixTest3SourcedEntity.class.st index e3c8f565..e4cc1694 100644 --- a/src/Famix-Test3-Entities/FamixTest3SourcedEntity.class.st +++ b/src/Famix-Test3-Entities/FamixTest3SourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3Type.class.st b/src/Famix-Test3-Entities/FamixTest3Type.class.st index e735e3b7..5c8caa9e 100644 --- a/src/Famix-Test3-Entities/FamixTest3Type.class.st +++ b/src/Famix-Test3-Entities/FamixTest3Type.class.st @@ -3,18 +3,25 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test3-Entities/FamixTest3UnknownSourceLanguage.class.st b/src/Famix-Test3-Entities/FamixTest3UnknownSourceLanguage.class.st index a56d0f2a..a3b071e6 100644 --- a/src/Famix-Test3-Entities/FamixTest3UnknownSourceLanguage.class.st +++ b/src/Famix-Test3-Entities/FamixTest3UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test4-Entities/FamixTest4Book.class.st b/src/Famix-Test4-Entities/FamixTest4Book.class.st index be289dc5..3b80215e 100644 --- a/src/Famix-Test4-Entities/FamixTest4Book.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Book.class.st @@ -3,7 +3,9 @@ ====================== ### Parents -- Relation: #person Type: #FamixTest4Person Opposite: #books +| Relation | Origin | Opposite | Type | Comment | +| `person` | `FamixTest4Book` | `books` | `FamixTest4Person` | | + " diff --git a/src/Famix-Test4-Entities/FamixTest4Entity.class.st b/src/Famix-Test4-Entities/FamixTest4Entity.class.st index 043ce142..ca6cfcb1 100644 --- a/src/Famix-Test4-Entities/FamixTest4Entity.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Entity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String +| Name | Type | Default value | Comment | +| `name` | `String` | nil | | " Class { diff --git a/src/Famix-Test4-Entities/FamixTest4Person.class.st b/src/Famix-Test4-Entities/FamixTest4Person.class.st index daa23f93..3506828d 100644 --- a/src/Famix-Test4-Entities/FamixTest4Person.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Person.class.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #books Type: #FamixTest4Book Opposite: #person +| Relation | Origin | Opposite | Type | Comment | +| `books` | `FamixTest4Person` | `person` | `FamixTest4Book` | | + " diff --git a/src/Famix-Test4-Entities/FamixTest4Principal.class.st b/src/Famix-Test4-Entities/FamixTest4Principal.class.st index 87a2f5d4..85925103 100644 --- a/src/Famix-Test4-Entities/FamixTest4Principal.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Principal.class.st @@ -3,7 +3,9 @@ ====================== ### Parents -- Relation: #school Type: #FamixTest4School Opposite: #principal +| Relation | Origin | Opposite | Type | Comment | +| `school` | `FamixTest4Principal` | `principal` | `FamixTest4School` | | + " diff --git a/src/Famix-Test4-Entities/FamixTest4Room.class.st b/src/Famix-Test4-Entities/FamixTest4Room.class.st index 1c55a525..5f65c6a7 100644 --- a/src/Famix-Test4-Entities/FamixTest4Room.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Room.class.st @@ -3,7 +3,9 @@ ====================== ### Parents -- Relation: #school Type: #FamixTest4School Opposite: #rooms +| Relation | Origin | Opposite | Type | Comment | +| `school` | `FamixTest4Room` | `rooms` | `FamixTest4School` | | + " diff --git a/src/Famix-Test4-Entities/FamixTest4School.class.st b/src/Famix-Test4-Entities/FamixTest4School.class.st index 06bce983..02401f1f 100644 --- a/src/Famix-Test4-Entities/FamixTest4School.class.st +++ b/src/Famix-Test4-Entities/FamixTest4School.class.st @@ -3,10 +3,12 @@ ====================== ### Children -- Relation: #principal Type: #FamixTest4Principal Opposite: #school -- Relation: #rooms Type: #FamixTest4Room Opposite: #school -- Relation: #students Type: #FamixTest4Student Opposite: #school -- Relation: #teachers Type: #FamixTest4Teacher Opposite: #school +| Relation | Origin | Opposite | Type | Comment | +| `principal` | `FamixTest4School` | `school` | `FamixTest4Principal` | | +| `rooms` | `FamixTest4School` | `school` | `FamixTest4Room` | | +| `students` | `FamixTest4School` | `school` | `FamixTest4Student` | | +| `teachers` | `FamixTest4School` | `school` | `FamixTest4Teacher` | | + " diff --git a/src/Famix-Test4-Entities/FamixTest4Student.class.st b/src/Famix-Test4-Entities/FamixTest4Student.class.st index 65902dc5..6cde618c 100644 --- a/src/Famix-Test4-Entities/FamixTest4Student.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Student.class.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #school Type: #FamixTest4School Opposite: #students +| Relation | Origin | Opposite | Type | Comment | +| `school` | `FamixTest4Student` | `students` | `FamixTest4School` | | + ### Other -- Relation: #teachers Type: #FamixTest4Teacher Opposite: #students +| Relation | Origin | Opposite | Type | Comment | +| `teachers` | `FamixTest4Student` | `students` | `FamixTest4Teacher` | | + " diff --git a/src/Famix-Test4-Entities/FamixTest4Teacher.class.st b/src/Famix-Test4-Entities/FamixTest4Teacher.class.st index 0b01fafe..88a37ca4 100644 --- a/src/Famix-Test4-Entities/FamixTest4Teacher.class.st +++ b/src/Famix-Test4-Entities/FamixTest4Teacher.class.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #school Type: #FamixTest4School Opposite: #teachers +| Relation | Origin | Opposite | Type | Comment | +| `school` | `FamixTest4Teacher` | `teachers` | `FamixTest4School` | | + ### Other -- Relation: #students Type: #FamixTest4Student Opposite: #teachers +| Relation | Origin | Opposite | Type | Comment | +| `students` | `FamixTest4Teacher` | `teachers` | `FamixTest4Student` | | + " diff --git a/src/Famix-Test5-Entities/FamixTest5AnnotationType1.class.st b/src/Famix-Test5-Entities/FamixTest5AnnotationType1.class.st index 7c73b053..d85ee166 100644 --- a/src/Famix-Test5-Entities/FamixTest5AnnotationType1.class.st +++ b/src/Famix-Test5-Entities/FamixTest5AnnotationType1.class.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #annotationTypesContainer Type: #FamixTWithAnnotationTypes Opposite: #definedAnnotationTypes Comment: Container in which an AnnotationType may reside +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypesContainer` | `FamixTAnnotationType` | `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | Container in which an AnnotationType may reside| + ### Other -- Relation: #instances Type: #FamixTTypedAnnotationInstance Opposite: #annotationType Comment: Annotations of this type +| Relation | Origin | Opposite | Type | Comment | +| `instances` | `FamixTAnnotationType` | `annotationType` | `FamixTTypedAnnotationInstance` | Annotations of this type| + " diff --git a/src/Famix-Test5-Entities/FamixTest5AnnotationType2.class.st b/src/Famix-Test5-Entities/FamixTest5AnnotationType2.class.st index f046e7d1..c67e61af 100644 --- a/src/Famix-Test5-Entities/FamixTest5AnnotationType2.class.st +++ b/src/Famix-Test5-Entities/FamixTest5AnnotationType2.class.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #annotationTypesContainer Type: #FamixTWithAnnotationTypes Opposite: #definedAnnotationTypes Comment: Container in which an AnnotationType may reside +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypesContainer` | `FamixTAnnotationType` | `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | Container in which an AnnotationType may reside| + ### Other -- Relation: #instances Type: #FamixTTypedAnnotationInstance Opposite: #annotationType Comment: Annotations of this type +| Relation | Origin | Opposite | Type | Comment | +| `instances` | `FamixTAnnotationType` | `annotationType` | `FamixTTypedAnnotationInstance` | Annotations of this type| + " diff --git a/src/Famix-Test5-Entities/FamixTest5WithAnnotationType1.class.st b/src/Famix-Test5-Entities/FamixTest5WithAnnotationType1.class.st index be4b0d68..ead519cf 100644 --- a/src/Famix-Test5-Entities/FamixTest5WithAnnotationType1.class.st +++ b/src/Famix-Test5-Entities/FamixTest5WithAnnotationType1.class.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #definedAnnotationTypes Type: #FamixTAnnotationType Opposite: #annotationTypesContainer Comment: The container in which the AnnotationTypes may be declared +| Relation | Origin | Opposite | Type | Comment | +| `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | `annotationTypesContainer` | `FamixTAnnotationType` | The container in which the AnnotationTypes may be declared| + " diff --git a/src/Famix-Test5-Entities/FamixTest5WithAnnotationType2.class.st b/src/Famix-Test5-Entities/FamixTest5WithAnnotationType2.class.st index b6d117ee..fad26eb8 100644 --- a/src/Famix-Test5-Entities/FamixTest5WithAnnotationType2.class.st +++ b/src/Famix-Test5-Entities/FamixTest5WithAnnotationType2.class.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #definedAnnotationTypes Type: #FamixTAnnotationType Opposite: #annotationTypesContainer Comment: The container in which the AnnotationTypes may be declared +| Relation | Origin | Opposite | Type | Comment | +| `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | `annotationTypesContainer` | `FamixTAnnotationType` | The container in which the AnnotationTypes may be declared| + " diff --git a/src/Famix-Test6-Entities/FamixTest6Bacon.class.st b/src/Famix-Test6-Entities/FamixTest6Bacon.class.st index df629097..e4d6a95a 100644 --- a/src/Famix-Test6-Entities/FamixTest6Bacon.class.st +++ b/src/Famix-Test6-Entities/FamixTest6Bacon.class.st @@ -2,8 +2,9 @@ ## Properties ====================== -- Named: #eggs Type: Number -- Named: #isFood Type: Boolean +| Name | Type | Default value | Comment | +| `eggs` | `Number` | 12 | | +| `isFood` | `Boolean` | true | | " Class { diff --git a/src/Famix-Test6-Entities/FamixTest6Comment.class.st b/src/Famix-Test6-Entities/FamixTest6Comment.class.st index cb8b981a..9e3bb385 100644 --- a/src/Famix-Test6-Entities/FamixTest6Comment.class.st +++ b/src/Famix-Test6-Entities/FamixTest6Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-Test6-Entities/FamixTest6NamedEntity.class.st b/src/Famix-Test6-Entities/FamixTest6NamedEntity.class.st index e3a1976b..e3a963ff 100644 --- a/src/Famix-Test6-Entities/FamixTest6NamedEntity.class.st +++ b/src/Famix-Test6-Entities/FamixTest6NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test6-Entities/FamixTest6SourceAnchor.class.st b/src/Famix-Test6-Entities/FamixTest6SourceAnchor.class.st index e2078b1e..be7cb906 100644 --- a/src/Famix-Test6-Entities/FamixTest6SourceAnchor.class.st +++ b/src/Famix-Test6-Entities/FamixTest6SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Test6-Entities/FamixTest6SourceLanguage.class.st b/src/Famix-Test6-Entities/FamixTest6SourceLanguage.class.st index fc1a4f4a..8d62f9d7 100644 --- a/src/Famix-Test6-Entities/FamixTest6SourceLanguage.class.st +++ b/src/Famix-Test6-Entities/FamixTest6SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test6-Entities/FamixTest6SourceTextAnchor.class.st b/src/Famix-Test6-Entities/FamixTest6SourceTextAnchor.class.st index 45d7e6ba..00367e37 100644 --- a/src/Famix-Test6-Entities/FamixTest6SourceTextAnchor.class.st +++ b/src/Famix-Test6-Entities/FamixTest6SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-Test6-Entities/FamixTest6SourcedEntity.class.st b/src/Famix-Test6-Entities/FamixTest6SourcedEntity.class.st index fd205437..64695fec 100644 --- a/src/Famix-Test6-Entities/FamixTest6SourcedEntity.class.st +++ b/src/Famix-Test6-Entities/FamixTest6SourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test6-Entities/FamixTest6Spam.class.st b/src/Famix-Test6-Entities/FamixTest6Spam.class.st index 2eedc82f..0f23584f 100644 --- a/src/Famix-Test6-Entities/FamixTest6Spam.class.st +++ b/src/Famix-Test6-Entities/FamixTest6Spam.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #isSomething Type: Boolean +| Name | Type | Default value | Comment | +| `isSomething` | `Boolean` | false | | " Class { diff --git a/src/Famix-Test6-Entities/FamixTest6UnknownSourceLanguage.class.st b/src/Famix-Test6-Entities/FamixTest6UnknownSourceLanguage.class.st index 5d3c2654..420779ec 100644 --- a/src/Famix-Test6-Entities/FamixTest6UnknownSourceLanguage.class.st +++ b/src/Famix-Test6-Entities/FamixTest6UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test7-Entities/FamixTest7Class.class.st b/src/Famix-Test7-Entities/FamixTest7Class.class.st index ad6b3aa2..c1d64192 100644 --- a/src/Famix-Test7-Entities/FamixTest7Class.class.st +++ b/src/Famix-Test7-Entities/FamixTest7Class.class.st @@ -3,26 +3,37 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7Comment.class.st b/src/Famix-Test7-Entities/FamixTest7Comment.class.st index 2ab66e4f..26cd53a3 100644 --- a/src/Famix-Test7-Entities/FamixTest7Comment.class.st +++ b/src/Famix-Test7-Entities/FamixTest7Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7Inheritance.class.st b/src/Famix-Test7-Entities/FamixTest7Inheritance.class.st index 91a4d0fe..adc757da 100644 --- a/src/Famix-Test7-Entities/FamixTest7Inheritance.class.st +++ b/src/Famix-Test7-Entities/FamixTest7Inheritance.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #subclass Type: #FamixTWithInheritances Opposite: #superInheritances Comment: Subclass linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `subclass` | `FamixTInheritance` | `superInheritances` | `FamixTWithInheritances` | Subclass linked to in this relationship. from-side of the association| + ### Association target -- Relation: #superclass Type: #FamixTWithInheritances Opposite: #subInheritances Comment: Superclass linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `superclass` | `FamixTInheritance` | `subInheritances` | `FamixTWithInheritances` | Superclass linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7Method.class.st b/src/Famix-Test7-Entities/FamixTest7Method.class.st index a01fb241..1abaac09 100644 --- a/src/Famix-Test7-Entities/FamixTest7Method.class.st +++ b/src/Famix-Test7-Entities/FamixTest7Method.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7NamedEntity.class.st b/src/Famix-Test7-Entities/FamixTest7NamedEntity.class.st index c45d0560..abbeec93 100644 --- a/src/Famix-Test7-Entities/FamixTest7NamedEntity.class.st +++ b/src/Famix-Test7-Entities/FamixTest7NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7SourceAnchor.class.st b/src/Famix-Test7-Entities/FamixTest7SourceAnchor.class.st index 1231d40c..624b0f03 100644 --- a/src/Famix-Test7-Entities/FamixTest7SourceAnchor.class.st +++ b/src/Famix-Test7-Entities/FamixTest7SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Test7-Entities/FamixTest7SourceLanguage.class.st b/src/Famix-Test7-Entities/FamixTest7SourceLanguage.class.st index a2d146b5..c335f4e0 100644 --- a/src/Famix-Test7-Entities/FamixTest7SourceLanguage.class.st +++ b/src/Famix-Test7-Entities/FamixTest7SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test7-Entities/FamixTest7SourceTextAnchor.class.st b/src/Famix-Test7-Entities/FamixTest7SourceTextAnchor.class.st index b69a5d9a..33125bad 100644 --- a/src/Famix-Test7-Entities/FamixTest7SourceTextAnchor.class.st +++ b/src/Famix-Test7-Entities/FamixTest7SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7SourcedEntity.class.st b/src/Famix-Test7-Entities/FamixTest7SourcedEntity.class.st index 1a4911cc..562b75a6 100644 --- a/src/Famix-Test7-Entities/FamixTest7SourcedEntity.class.st +++ b/src/Famix-Test7-Entities/FamixTest7SourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test7-Entities/FamixTest7UnknownSourceLanguage.class.st b/src/Famix-Test7-Entities/FamixTest7UnknownSourceLanguage.class.st index 08d61bf1..21a440e1 100644 --- a/src/Famix-Test7-Entities/FamixTest7UnknownSourceLanguage.class.st +++ b/src/Famix-Test7-Entities/FamixTest7UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Test8-Entities/FamixTest8Animal.class.st b/src/Famix-Test8-Entities/FamixTest8Animal.class.st index ab86d762..9fdb634b 100644 --- a/src/Famix-Test8-Entities/FamixTest8Animal.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Animal.class.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingInfections Type: #FamixTest8Infection Opposite: #infectious +| Relation | Origin | Opposite | Type | Comment | +| `incomingInfections` | `FamixTest8TInfectious` | `infectious` | `FamixTest8Infection` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8Bacteria.class.st b/src/Famix-Test8-Entities/FamixTest8Bacteria.class.st index bd57c4e8..34a6aca5 100644 --- a/src/Famix-Test8-Entities/FamixTest8Bacteria.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Bacteria.class.st @@ -3,12 +3,15 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingInfections Type: #FamixTest8Infection Opposite: #infectable +| Relation | Origin | Opposite | Type | Comment | +| `outgoingInfections` | `FamixTest8TInfectable` | `infectable` | `FamixTest8Infection` | | + ## Properties ====================== -- Named: #pathogenicity Type: Number +| Name | Type | Default value | Comment | +| `pathogenicity` | `Number` | nil | | " Class { diff --git a/src/Famix-Test8-Entities/FamixTest8Biotope.class.st b/src/Famix-Test8-Entities/FamixTest8Biotope.class.st index 4beca36d..ee2c50d8 100644 --- a/src/Famix-Test8-Entities/FamixTest8Biotope.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Biotope.class.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingResidences Type: #FamixTest8Residence Opposite: #biotope +| Relation | Origin | Opposite | Type | Comment | +| `incomingResidences` | `FamixTest8TBiotope` | `biotope` | `FamixTest8Residence` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8Infection.class.st b/src/Famix-Test8-Entities/FamixTest8Infection.class.st index 29dc8664..2d7c9898 100644 --- a/src/Famix-Test8-Entities/FamixTest8Infection.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Infection.class.st @@ -3,19 +3,26 @@ ====================== ### Association source -- Relation: #infectable Type: #FamixTest8TInfectable Opposite: #outgoingInfections +| Relation | Origin | Opposite | Type | Comment | +| `infectable` | `FamixTest8Infection` | `outgoingInfections` | `FamixTest8TInfectable` | | + ### Association target -- Relation: #infectious Type: #FamixTest8TInfectious Opposite: #incomingInfections +| Relation | Origin | Opposite | Type | Comment | +| `infectious` | `FamixTest8Infection` | `incomingInfections` | `FamixTest8TInfectious` | | + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isInvasive Type: Boolean -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isInvasive` | `Boolean` | false | | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test8-Entities/FamixTest8LivingBeing.class.st b/src/Famix-Test8-Entities/FamixTest8LivingBeing.class.st index f9741c0c..cb7019fb 100644 --- a/src/Famix-Test8-Entities/FamixTest8LivingBeing.class.st +++ b/src/Famix-Test8-Entities/FamixTest8LivingBeing.class.st @@ -3,7 +3,9 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingResidences Type: #FamixTest8Residence Opposite: #resident +| Relation | Origin | Opposite | Type | Comment | +| `outgoingResidences` | `FamixTest8TResident` | `resident` | `FamixTest8Residence` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8Plant.class.st b/src/Famix-Test8-Entities/FamixTest8Plant.class.st index acb0a274..f3cb68e8 100644 --- a/src/Famix-Test8-Entities/FamixTest8Plant.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Plant.class.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingInfections Type: #FamixTest8Infection Opposite: #infectious +| Relation | Origin | Opposite | Type | Comment | +| `incomingInfections` | `FamixTest8TInfectious` | `infectious` | `FamixTest8Infection` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8Residence.class.st b/src/Famix-Test8-Entities/FamixTest8Residence.class.st index b6b61343..5efcdac6 100644 --- a/src/Famix-Test8-Entities/FamixTest8Residence.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Residence.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #resident Type: #FamixTest8TResident Opposite: #outgoingResidences +| Relation | Origin | Opposite | Type | Comment | +| `resident` | `FamixTest8Residence` | `outgoingResidences` | `FamixTest8TResident` | | + ### Association target -- Relation: #biotope Type: #FamixTest8TBiotope Opposite: #incomingResidences +| Relation | Origin | Opposite | Type | Comment | +| `biotope` | `FamixTest8Residence` | `incomingResidences` | `FamixTest8TBiotope` | | + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-Test8-Entities/FamixTest8TBiotope.trait.st b/src/Famix-Test8-Entities/FamixTest8TBiotope.trait.st index dc4cf7cd..4e1c4fe7 100644 --- a/src/Famix-Test8-Entities/FamixTest8TBiotope.trait.st +++ b/src/Famix-Test8-Entities/FamixTest8TBiotope.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingResidences Type: #FamixTest8Residence Opposite: #biotope +| Relation | Origin | Opposite | Type | Comment | +| `incomingResidences` | `FamixTest8TBiotope` | `biotope` | `FamixTest8Residence` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8TInfectable.trait.st b/src/Famix-Test8-Entities/FamixTest8TInfectable.trait.st index dc226834..e8cf5258 100644 --- a/src/Famix-Test8-Entities/FamixTest8TInfectable.trait.st +++ b/src/Famix-Test8-Entities/FamixTest8TInfectable.trait.st @@ -3,12 +3,15 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingInfections Type: #FamixTest8Infection Opposite: #infectable +| Relation | Origin | Opposite | Type | Comment | +| `outgoingInfections` | `FamixTest8TInfectable` | `infectable` | `FamixTest8Infection` | | + ## Properties ====================== -- Named: #pathogenicity Type: Number +| Name | Type | Default value | Comment | +| `pathogenicity` | `Number` | nil | | " Trait { diff --git a/src/Famix-Test8-Entities/FamixTest8TInfectious.trait.st b/src/Famix-Test8-Entities/FamixTest8TInfectious.trait.st index 427ed8db..2f344ec0 100644 --- a/src/Famix-Test8-Entities/FamixTest8TInfectious.trait.st +++ b/src/Famix-Test8-Entities/FamixTest8TInfectious.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingInfections Type: #FamixTest8Infection Opposite: #infectious +| Relation | Origin | Opposite | Type | Comment | +| `incomingInfections` | `FamixTest8TInfectious` | `infectious` | `FamixTest8Infection` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8TResident.trait.st b/src/Famix-Test8-Entities/FamixTest8TResident.trait.st index 9e2bc995..e9c8101e 100644 --- a/src/Famix-Test8-Entities/FamixTest8TResident.trait.st +++ b/src/Famix-Test8-Entities/FamixTest8TResident.trait.st @@ -3,7 +3,9 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingResidences Type: #FamixTest8Residence Opposite: #resident +| Relation | Origin | Opposite | Type | Comment | +| `outgoingResidences` | `FamixTest8TResident` | `resident` | `FamixTest8Residence` | | + " diff --git a/src/Famix-Test8-Entities/FamixTest8Virus.class.st b/src/Famix-Test8-Entities/FamixTest8Virus.class.st index 6f55792f..081d686f 100644 --- a/src/Famix-Test8-Entities/FamixTest8Virus.class.st +++ b/src/Famix-Test8-Entities/FamixTest8Virus.class.st @@ -3,12 +3,15 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingInfections Type: #FamixTest8Infection Opposite: #infectable +| Relation | Origin | Opposite | Type | Comment | +| `outgoingInfections` | `FamixTest8TInfectable` | `infectable` | `FamixTest8Infection` | | + ## Properties ====================== -- Named: #pathogenicity Type: Number +| Name | Type | Default value | Comment | +| `pathogenicity` | `Number` | nil | | " Class { diff --git a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedAssociation.class.st b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedAssociation.class.st index 125c6717..2b55f2e4 100644 --- a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedAssociation.class.st +++ b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedAssociation.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #c25 Type: #FamixTestComposed2CustomEntity5 Opposite: #associations +| Relation | Origin | Opposite | Type | Comment | +| `c25` | `FamixTestComposedAssociation` | `associations` | `FamixTestComposed2CustomEntity5` | | + ### Association target -- Relation: #c15 Type: #FamixTestComposed1CustomEntity5 Opposite: #associations +| Relation | Origin | Opposite | Type | Comment | +| `c15` | `FamixTestComposedAssociation` | `associations` | `FamixTestComposed1CustomEntity5` | | + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity1.class.st b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity1.class.st index 915fee5f..c6a00482 100644 --- a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity1.class.st +++ b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity1.class.st @@ -3,9 +3,13 @@ ====================== ### Children -- Relation: #customEntity1 Type: #FamixTestComposed1CustomEntity1 Opposite: #customEntity1 +| Relation | Origin | Opposite | Type | Comment | +| `customEntity1` | `FamixTestComposedCustomEntity1` | `customEntity1` | `FamixTestComposed1CustomEntity1` | | + ### Other -- Relation: #c21 Type: #FamixTestComposed2CustomEntity1 Opposite: #c1 +| Relation | Origin | Opposite | Type | Comment | +| `c21` | `FamixTestComposedCustomEntity1` | `c1` | `FamixTestComposed2CustomEntity1` | | + " diff --git a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity2.class.st b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity2.class.st index 1ec842dc..742e0e50 100644 --- a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity2.class.st +++ b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity2.class.st @@ -3,8 +3,10 @@ ====================== ### Other -- Relation: #c22s Type: #FamixTestComposed2CustomEntity2 Opposite: #c2 -- Relation: #customEntities2 Type: #FamixTestComposed1CustomEntity2 Opposite: #customEntity2 +| Relation | Origin | Opposite | Type | Comment | +| `c22s` | `FamixTestComposedCustomEntity2` | `c2` | `FamixTestComposed2CustomEntity2` | | +| `customEntities2` | `FamixTestComposedCustomEntity2` | `customEntity2` | `FamixTestComposed1CustomEntity2` | | + " diff --git a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity3.class.st b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity3.class.st index 703bcccb..a362a0e8 100644 --- a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity3.class.st +++ b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity3.class.st @@ -3,8 +3,10 @@ ====================== ### Other -- Relation: #c23 Type: #FamixTestComposed2CustomEntity3 Opposite: #c3s -- Relation: #customEntity3 Type: #FamixTestComposed1CustomEntity3 Opposite: #customEntities3 +| Relation | Origin | Opposite | Type | Comment | +| `c23` | `FamixTestComposedCustomEntity3` | `c3s` | `FamixTestComposed2CustomEntity3` | | +| `customEntity3` | `FamixTestComposedCustomEntity3` | `customEntities3` | `FamixTestComposed1CustomEntity3` | | + " diff --git a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity4.class.st b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity4.class.st index b377f357..8054c83e 100644 --- a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity4.class.st +++ b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedCustomEntity4.class.st @@ -3,8 +3,10 @@ ====================== ### Other -- Relation: #c24s Type: #FamixTestComposed2CustomEntity4 Opposite: #c4s -- Relation: #customEntities4 Type: #FamixTestComposed1CustomEntity4 Opposite: #customEntities4 +| Relation | Origin | Opposite | Type | Comment | +| `c24s` | `FamixTestComposedCustomEntity4` | `c4s` | `FamixTestComposed2CustomEntity4` | | +| `customEntities4` | `FamixTestComposedCustomEntity4` | `customEntities4` | `FamixTestComposed1CustomEntity4` | | + " diff --git a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedStandardEntity.class.st b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedStandardEntity.class.st index 6b7d2f4c..6d08e3fa 100644 --- a/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedStandardEntity.class.st +++ b/src/Famix-TestComposedMetamodel-Entities/FamixTestComposedStandardEntity.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #method Type: #FamixTestComposed1Method Opposite: #standardEntity +| Relation | Origin | Opposite | Type | Comment | +| `method` | `FamixTestComposedStandardEntity` | `standardEntity` | `FamixTestComposed1Method` | | + " diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Class.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Class.class.st index 43509f1d..d29280c4 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Class.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Class.class.st @@ -3,26 +3,37 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Comment.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Comment.class.st index 11a5d6e2..58f83a69 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Comment.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Method.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Method.class.st index e8191af1..642d30ec 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Method.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1Method.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1NamedEntity.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1NamedEntity.class.st index 417e75a6..74bf4ec3 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1NamedEntity.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceAnchor.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceAnchor.class.st index 918ce8d9..0e1f401d 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceAnchor.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceLanguage.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceLanguage.class.st index 512f977a..efb9f9f5 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceLanguage.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceTextAnchor.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceTextAnchor.class.st index 3abc6a40..29b44474 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceTextAnchor.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourcedEntity.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourcedEntity.class.st index 1019ac21..51cb1e91 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourcedEntity.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1SourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1UnknownSourceLanguage.class.st b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1UnknownSourceLanguage.class.st index f1c1da01..26ade1b7 100644 --- a/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1UnknownSourceLanguage.class.st +++ b/src/Famix-TestComposedSubmetamodel1-Entities/FamixTestComposed1UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Class.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Class.class.st index e8f819c7..24fc5146 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Class.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Class.class.st @@ -3,26 +3,37 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Comment.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Comment.class.st index ed9cb26d..0db154e8 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Comment.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Comment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Method.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Method.class.st index ca4c3503..a8251974 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Method.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2Method.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2NamedEntity.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2NamedEntity.class.st index 1f36aa3e..9198cecf 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2NamedEntity.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2NamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceAnchor.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceAnchor.class.st index 6eee51af..f8a585cb 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceAnchor.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceLanguage.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceLanguage.class.st index 4d4184e6..7290ca32 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceLanguage.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceTextAnchor.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceTextAnchor.class.st index e3b191f9..4693aa56 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceTextAnchor.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourcedEntity.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourcedEntity.class.st index 6d4d1e28..1c465cab 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourcedEntity.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2SourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2UnknownSourceLanguage.class.st b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2UnknownSourceLanguage.class.st index f1c027dc..fa6ebea7 100644 --- a/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2UnknownSourceLanguage.class.st +++ b/src/Famix-TestComposedSubmetamodel2-Entities/FamixTestComposed2UnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Traits/FamixTAccess.trait.st b/src/Famix-Traits/FamixTAccess.trait.st index 70d60d78..693dcfc5 100644 --- a/src/Famix-Traits/FamixTAccess.trait.st +++ b/src/Famix-Traits/FamixTAccess.trait.st @@ -16,19 +16,26 @@ For each access in the source code, there is one famix access created even if it ====================== ### Association source -- Relation: #accessor Type: #FamixTWithAccesses Opposite: #accesses Comment: Behavioural entity making the access to the variable. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `accessor` | `FamixTAccess` | `accesses` | `FamixTWithAccesses` | Behavioural entity making the access to the variable. from-side of the association| + ### Association target -- Relation: #variable Type: #FamixTAccessible Opposite: #incomingAccesses Comment: Variable accessed. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `variable` | `FamixTAccess` | `incomingAccesses` | `FamixTAccessible` | Variable accessed. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #isWrite Type: Boolean Comment: Write access +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `isWrite` | `Boolean` | false | Write access| " Trait { diff --git a/src/Famix-Traits/FamixTAccessible.trait.st b/src/Famix-Traits/FamixTAccessible.trait.st index 990470e4..694f4717 100644 --- a/src/Famix-Traits/FamixTAccessible.trait.st +++ b/src/Famix-Traits/FamixTAccessible.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + " diff --git a/src/Famix-Traits/FamixTAnnotationInstance.trait.st b/src/Famix-Traits/FamixTAnnotationInstance.trait.st index 210418d1..767f230b 100644 --- a/src/Famix-Traits/FamixTAnnotationInstance.trait.st +++ b/src/Famix-Traits/FamixTAnnotationInstance.trait.st @@ -15,7 +15,9 @@ Instance Variables: ====================== ### Other -- Relation: #annotatedEntity Type: #FamixTWithAnnotationInstances Opposite: #annotationInstances Comment: The NamedEntity on which the annotation occurs. +| Relation | Origin | Opposite | Type | Comment | +| `annotatedEntity` | `FamixTAnnotationInstance` | `annotationInstances` | `FamixTWithAnnotationInstances` | The NamedEntity on which the annotation occurs.| + " diff --git a/src/Famix-Traits/FamixTAnnotationInstanceAttribute.trait.st b/src/Famix-Traits/FamixTAnnotationInstanceAttribute.trait.st index cac9c3d7..7beb6a74 100644 --- a/src/Famix-Traits/FamixTAnnotationInstanceAttribute.trait.st +++ b/src/Famix-Traits/FamixTAnnotationInstanceAttribute.trait.st @@ -13,12 +13,15 @@ Instance Variables: ====================== ### Parents -- Relation: #parentAnnotationInstance Type: #FamixTWithAnnotationInstanceAttributes Opposite: #attributes Comment: The instance of the annotation in which the attribute is used. +| Relation | Origin | Opposite | Type | Comment | +| `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | `attributes` | `FamixTWithAnnotationInstanceAttributes` | The instance of the annotation in which the attribute is used.| + ## Properties ====================== -- Named: #value Type: String Comment: Actual value of the attribute used in an annotation +| Name | Type | Default value | Comment | +| `value` | `String` | nil | Actual value of the attribute used in an annotation| " Trait { diff --git a/src/Famix-Traits/FamixTAnnotationType.trait.st b/src/Famix-Traits/FamixTAnnotationType.trait.st index 637e5f75..1feac75d 100644 --- a/src/Famix-Traits/FamixTAnnotationType.trait.st +++ b/src/Famix-Traits/FamixTAnnotationType.trait.st @@ -9,9 +9,13 @@ Instance Variables: ====================== ### Parents -- Relation: #annotationTypesContainer Type: #FamixTWithAnnotationTypes Opposite: #definedAnnotationTypes Comment: Container in which an AnnotationType may reside +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypesContainer` | `FamixTAnnotationType` | `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | Container in which an AnnotationType may reside| + ### Other -- Relation: #instances Type: #FamixTTypedAnnotationInstance Opposite: #annotationType Comment: Annotations of this type +| Relation | Origin | Opposite | Type | Comment | +| `instances` | `FamixTAnnotationType` | `annotationType` | `FamixTTypedAnnotationInstance` | Annotations of this type| + " diff --git a/src/Famix-Traits/FamixTAnnotationTypeAttribute.trait.st b/src/Famix-Traits/FamixTAnnotationTypeAttribute.trait.st index 068f1916..f38f006d 100644 --- a/src/Famix-Traits/FamixTAnnotationTypeAttribute.trait.st +++ b/src/Famix-Traits/FamixTAnnotationTypeAttribute.trait.st @@ -20,19 +20,26 @@ Instance Variables: ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #annotationAttributeInstances Type: #FamixTTypedAnnotationInstanceAttribute Opposite: #annotationTypeAttribute Comment: A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances| +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTAssociation.trait.st b/src/Famix-Traits/FamixTAssociation.trait.st index 539d97fc..6ae72a40 100644 --- a/src/Famix-Traits/FamixTAssociation.trait.st +++ b/src/Famix-Traits/FamixTAssociation.trait.st @@ -21,14 +21,17 @@ will produce two invocation associations first from method a to method b, and se ====================== ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTAttribute.trait.st b/src/Famix-Traits/FamixTAttribute.trait.st index 3cf0520c..16e7412e 100644 --- a/src/Famix-Traits/FamixTAttribute.trait.st +++ b/src/Famix-Traits/FamixTAttribute.trait.st @@ -6,18 +6,25 @@ FamixTAttribute represents a field of a class. It is an attribute of the parent ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTCanBeAbstract.trait.st b/src/Famix-Traits/FamixTCanBeAbstract.trait.st index cff78ea9..0bb77499 100644 --- a/src/Famix-Traits/FamixTCanBeAbstract.trait.st +++ b/src/Famix-Traits/FamixTCanBeAbstract.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #isAbstract Type: Boolean Comment: Entity can be declared abstract +| Name | Type | Default value | Comment | +| `isAbstract` | `Boolean` | false | Entity can be declared abstract| " Trait { diff --git a/src/Famix-Traits/FamixTCanBeClassSide.trait.st b/src/Famix-Traits/FamixTCanBeClassSide.trait.st index aa82a5f2..75e02ae1 100644 --- a/src/Famix-Traits/FamixTCanBeClassSide.trait.st +++ b/src/Famix-Traits/FamixTCanBeClassSide.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #isClassSide Type: Boolean Comment: Entity can be declared class side i.e. static +| Name | Type | Default value | Comment | +| `isClassSide` | `Boolean` | false | Entity can be declared class side i.e. static| " Trait { diff --git a/src/Famix-Traits/FamixTCanBeFinal.trait.st b/src/Famix-Traits/FamixTCanBeFinal.trait.st index 37afb0c3..2af04131 100644 --- a/src/Famix-Traits/FamixTCanBeFinal.trait.st +++ b/src/Famix-Traits/FamixTCanBeFinal.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #isFinal Type: Boolean Comment: Entity can be declared final +| Name | Type | Default value | Comment | +| `isFinal` | `Boolean` | false | Entity can be declared final| " Trait { diff --git a/src/Famix-Traits/FamixTCanImplement.trait.st b/src/Famix-Traits/FamixTCanImplement.trait.st index 1a8eef28..2cdeb0e3 100644 --- a/src/Famix-Traits/FamixTCanImplement.trait.st +++ b/src/Famix-Traits/FamixTCanImplement.trait.st @@ -5,7 +5,9 @@ I can be the source of an implementation (cf a class implementing an Interface) ====================== ### Outgoing dependencies -- Relation: #interfaceImplementations Type: #FamixTImplementation Opposite: #implementingClass Comment: Implementation relationships +| Relation | Origin | Opposite | Type | Comment | +| `interfaceImplementations` | `FamixTCanImplement` | `implementingClass` | `FamixTImplementation` | Implementation relationships| + " diff --git a/src/Famix-Traits/FamixTClass.trait.st b/src/Famix-Traits/FamixTClass.trait.st index ef8f2c75..3fcb7fa1 100644 --- a/src/Famix-Traits/FamixTClass.trait.st +++ b/src/Famix-Traits/FamixTClass.trait.st @@ -9,26 +9,37 @@ A class is typically scoped in a namespace. To model nested or anonymous classes ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTClassWithVisibility.trait.st b/src/Famix-Traits/FamixTClassWithVisibility.trait.st index 79e994da..d9967ebe 100644 --- a/src/Famix-Traits/FamixTClassWithVisibility.trait.st +++ b/src/Famix-Traits/FamixTClassWithVisibility.trait.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `visibility` | `String` | nil | Visibility of the entity| " Trait { diff --git a/src/Famix-Traits/FamixTCohesionCouplingMetrics.trait.st b/src/Famix-Traits/FamixTCohesionCouplingMetrics.trait.st index f5cc0c41..58e0f4d4 100644 --- a/src/Famix-Traits/FamixTCohesionCouplingMetrics.trait.st +++ b/src/Famix-Traits/FamixTCohesionCouplingMetrics.trait.st @@ -3,15 +3,20 @@ ====================== ### Children -- Relation: #childEntities Type: #FamixTPackageable Opposite: #parentPackage +| Relation | Origin | Opposite | Type | Comment | +| `childEntities` | `FamixTPackage` | `parentPackage` | `FamixTPackageable` | | + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTComment.trait.st b/src/Famix-Traits/FamixTComment.trait.st index 7eeda11a..f841fbfd 100644 --- a/src/Famix-Traits/FamixTComment.trait.st +++ b/src/Famix-Traits/FamixTComment.trait.st @@ -5,12 +5,15 @@ FamixTComment represents one instance of a comment (in the sense of programming ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Trait { diff --git a/src/Famix-Traits/FamixTCompilationUnit.trait.st b/src/Famix-Traits/FamixTCompilationUnit.trait.st index cb487d4c..f5ef4a4e 100644 --- a/src/Famix-Traits/FamixTCompilationUnit.trait.st +++ b/src/Famix-Traits/FamixTCompilationUnit.trait.st @@ -5,10 +5,14 @@ I represent a compilation unit file. Typically a .c or .cpp file ====================== ### Parents -- Relation: #compilationUnitOwner Type: #FamixTWithCompilationUnits Opposite: #compilationUnit Comment: The compilation unit that defines this module -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `compilationUnitOwner` | `FamixTCompilationUnit` | `compilationUnit` | `FamixTWithCompilationUnits` | The compilation unit that defines this module| +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + ### Other -- Relation: #entities Type: #FamixTWithFiles Opposite: #containerFiles Comment: List of entities defined in the file +| Relation | Origin | Opposite | Type | Comment | +| `entities` | `FamixTFile` | `containerFiles` | `FamixTWithFiles` | List of entities defined in the file| + " diff --git a/src/Famix-Traits/FamixTDefinedInModule.trait.st b/src/Famix-Traits/FamixTDefinedInModule.trait.st index f096c625..6345aacb 100644 --- a/src/Famix-Traits/FamixTDefinedInModule.trait.st +++ b/src/Famix-Traits/FamixTDefinedInModule.trait.st @@ -3,7 +3,9 @@ ====================== ### Parents -- Relation: #parentModule Type: #FamixTModule Opposite: #moduleEntities Comment: Module that contains the definition of this entity +| Relation | Origin | Opposite | Type | Comment | +| `parentModule` | `FamixTDefinedInModule` | `moduleEntities` | `FamixTModule` | Module that contains the definition of this entity| + " diff --git a/src/Famix-Traits/FamixTDereferencedInvocation.trait.st b/src/Famix-Traits/FamixTDereferencedInvocation.trait.st index cdfb0bc4..20b78ade 100644 --- a/src/Famix-Traits/FamixTDereferencedInvocation.trait.st +++ b/src/Famix-Traits/FamixTDereferencedInvocation.trait.st @@ -9,21 +9,28 @@ It has a referencer which is the pointer variable ====================== ### Association source -- Relation: #sender Type: #FamixTWithInvocations Opposite: #outgoingInvocations Comment: Behavioural entity making the call. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `sender` | `FamixTInvocation` | `outgoingInvocations` | `FamixTWithInvocations` | Behavioural entity making the call. from-side of the association| + ### Association target -- Relation: #candidates Type: #FamixTInvocable Opposite: #incomingInvocations Comment: List of candidate behavioural entities for receiving the invocation +| Relation | Origin | Opposite | Type | Comment | +| `candidates` | `FamixTInvocation` | `incomingInvocations` | `FamixTInvocable` | List of candidate behavioural entities for receiving the invocation| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #receiver Type: #FamixTInvocationsReceiver Opposite: #receivingInvocations Comment: Named entity (variable, class...) receiving the invocation. to-side of the association -- Relation: #referencer Type: #FamixTWithDereferencedInvocations Opposite: #dereferencedInvocations Comment: Structural entity that references the BehaviouralEntity invoked -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `receiver` | `FamixTInvocation` | `receivingInvocations` | `FamixTInvocationsReceiver` | Named entity (variable, class...) receiving the invocation. to-side of the association| +| `referencer` | `FamixTDereferencedInvocation` | `dereferencedInvocations` | `FamixTWithDereferencedInvocations` | Structural entity that references the BehaviouralEntity invoked| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `signature` | `String` | nil | Signature of the message being sent| " Trait { diff --git a/src/Famix-Traits/FamixTEnum.trait.st b/src/Famix-Traits/FamixTEnum.trait.st index f88149d2..3e6c64eb 100644 --- a/src/Famix-Traits/FamixTEnum.trait.st +++ b/src/Famix-Traits/FamixTEnum.trait.st @@ -15,20 +15,29 @@ Instance Variables: ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #enumValues Type: #FamixTEnumValue Opposite: #parentEnum +| Relation | Origin | Opposite | Type | Comment | +| `enumValues` | `FamixTWithEnumValues` | `parentEnum` | `FamixTEnumValue` | | + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTEnumValue.trait.st b/src/Famix-Traits/FamixTEnumValue.trait.st index b8457a14..f4e9a44b 100644 --- a/src/Famix-Traits/FamixTEnumValue.trait.st +++ b/src/Famix-Traits/FamixTEnumValue.trait.st @@ -15,18 +15,25 @@ Instance Variables: ====================== ### Parents -- Relation: #parentEnum Type: #FamixTWithEnumValues Opposite: #enumValues Comment: The Enum declaring this value. It offers the implementation of belongsTo +| Relation | Origin | Opposite | Type | Comment | +| `parentEnum` | `FamixTEnumValue` | `enumValues` | `FamixTWithEnumValues` | The Enum declaring this value. It offers the implementation of belongsTo| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTException.trait.st b/src/Famix-Traits/FamixTException.trait.st index 5804ec21..9db9488f 100644 --- a/src/Famix-Traits/FamixTException.trait.st +++ b/src/Famix-Traits/FamixTException.trait.st @@ -5,29 +5,40 @@ This is the abstract representation of an Exception. It is specific to Java. It ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #catchingEntities Type: #FamixTWithExceptions Opposite: #caughtExceptions -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #declaringEntities Type: #FamixTWithExceptions Opposite: #declaredExceptions -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #throwingEntities Type: #FamixTWithExceptions Opposite: #thrownExceptions -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `catchingEntities` | `FamixTException` | `caughtExceptions` | `FamixTWithExceptions` | | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `declaringEntities` | `FamixTException` | `declaredExceptions` | `FamixTWithExceptions` | | +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `throwingEntities` | `FamixTException` | `thrownExceptions` | `FamixTWithExceptions` | | +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTFile.trait.st b/src/Famix-Traits/FamixTFile.trait.st index 71e3741a..4aab6bde 100644 --- a/src/Famix-Traits/FamixTFile.trait.st +++ b/src/Famix-Traits/FamixTFile.trait.st @@ -5,9 +5,13 @@ It represents a file in the file system. ====================== ### Parents -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + ### Other -- Relation: #entities Type: #FamixTWithFiles Opposite: #containerFiles Comment: List of entities defined in the file +| Relation | Origin | Opposite | Type | Comment | +| `entities` | `FamixTFile` | `containerFiles` | `FamixTWithFiles` | List of entities defined in the file| + " diff --git a/src/Famix-Traits/FamixTFileAnchor.trait.st b/src/Famix-Traits/FamixTFileAnchor.trait.st index 6fd5738b..fbef7c93 100644 --- a/src/Famix-Traits/FamixTFileAnchor.trait.st +++ b/src/Famix-Traits/FamixTFileAnchor.trait.st @@ -4,9 +4,10 @@ This offers a source anchor that connects a sourced entity to a file through a r ## Properties ====================== -- Named: #correspondingFile Type: FamixTFile Comment: File associated to this source anchor -- Named: #encoding Type: String Comment: A string representing the encoding of a file -- Named: #fileName Type: String Comment: Name of the source file +| Name | Type | Default value | Comment | +| `correspondingFile` | `FamixTFile` | nil | File associated to this source anchor| +| `encoding` | `String` | nil | A string representing the encoding of a file| +| `fileName` | `String` | nil | Name of the source file| " Trait { diff --git a/src/Famix-Traits/FamixTFileInclude.trait.st b/src/Famix-Traits/FamixTFileInclude.trait.st index 91134485..ef66ce2c 100644 --- a/src/Famix-Traits/FamixTFileInclude.trait.st +++ b/src/Famix-Traits/FamixTFileInclude.trait.st @@ -3,16 +3,19 @@ ====================== ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #source Type: #FamixTWithFileIncludes Opposite: #outgoingIncludeRelations Comment: The file that is including -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #target Type: #FamixTWithFileIncludes Opposite: #incomingIncludeRelations Comment: The file that is included +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `source` | `FamixTFileInclude` | `outgoingIncludeRelations` | `FamixTWithFileIncludes` | The file that is including| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `target` | `FamixTFileInclude` | `incomingIncludeRelations` | `FamixTWithFileIncludes` | The file that is included| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTFileNavigation.trait.st b/src/Famix-Traits/FamixTFileNavigation.trait.st index 534aefaf..dde907c5 100644 --- a/src/Famix-Traits/FamixTFileNavigation.trait.st +++ b/src/Famix-Traits/FamixTFileNavigation.trait.st @@ -2,13 +2,14 @@ ## Properties ====================== -- Named: #correspondingFile Type: FamixTFile Comment: File associated to this source anchor -- Named: #encoding Type: String Comment: A string representing the encoding of a file -- Named: #endColumn Type: Number Comment: Number of the end column -- Named: #endLine Type: Number Comment: Number of the end line -- Named: #fileName Type: String Comment: Name of the source file -- Named: #startColumn Type: Number Comment: Number of the start column -- Named: #startLine Type: Number Comment: Number of the start line +| Name | Type | Default value | Comment | +| `correspondingFile` | `FamixTFile` | nil | File associated to this source anchor| +| `encoding` | `String` | nil | A string representing the encoding of a file| +| `endColumn` | `Number` | nil | Number of the end column| +| `endLine` | `Number` | nil | Number of the end line| +| `fileName` | `String` | nil | Name of the source file| +| `startColumn` | `Number` | nil | Number of the start column| +| `startLine` | `Number` | nil | Number of the start line| " Trait { diff --git a/src/Famix-Traits/FamixTFileSystemEntity.trait.st b/src/Famix-Traits/FamixTFileSystemEntity.trait.st index 2d03c5cb..b152504a 100644 --- a/src/Famix-Traits/FamixTFileSystemEntity.trait.st +++ b/src/Famix-Traits/FamixTFileSystemEntity.trait.st @@ -3,7 +3,9 @@ ====================== ### Parents -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + " diff --git a/src/Famix-Traits/FamixTFolder.trait.st b/src/Famix-Traits/FamixTFolder.trait.st index 916eaa3d..a33bde92 100644 --- a/src/Famix-Traits/FamixTFolder.trait.st +++ b/src/Famix-Traits/FamixTFolder.trait.st @@ -5,9 +5,13 @@ It represents a folder in the file system. It can contain other files or folders ====================== ### Parents -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + ### Children -- Relation: #childrenFileSystemEntities Type: #FamixTFileSystemEntity Opposite: #parentFolder Comment: List of entities contained in this folder. +| Relation | Origin | Opposite | Type | Comment | +| `childrenFileSystemEntities` | `FamixTFolder` | `parentFolder` | `FamixTFileSystemEntity` | List of entities contained in this folder.| + " diff --git a/src/Famix-Traits/FamixTFunction.trait.st b/src/Famix-Traits/FamixTFunction.trait.st index 2322f105..44d33f3e 100644 --- a/src/Famix-Traits/FamixTFunction.trait.st +++ b/src/Famix-Traits/FamixTFunction.trait.st @@ -5,24 +5,33 @@ FamixTFunction represents a behavioural entity in a procedural language. ====================== ### Parents -- Relation: #functionOwner Type: #FamixTWithFunctions Opposite: #functions Comment: The container defining the function. The function is placed in a container, because certain languages can nest functions in functions. +| Relation | Origin | Opposite | Type | Comment | +| `functionOwner` | `FamixTFunction` | `functions` | `FamixTWithFunctions` | The container defining the function. The function is placed in a container, because certain languages can nest functions in functions.| + ### Children -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `localVariables` | `FamixTWithLocalVariables` | `parentBehaviouralEntity` | `FamixTLocalVariable` | Variables locally defined by this behaviour.| +| `parameters` | `FamixTWithParameters` | `parentBehaviouralEntity` | `FamixTParameter` | List of formal parameters declared by this behaviour.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Trait { diff --git a/src/Famix-Traits/FamixTGlobalVariable.trait.st b/src/Famix-Traits/FamixTGlobalVariable.trait.st index e2181550..3fb62323 100644 --- a/src/Famix-Traits/FamixTGlobalVariable.trait.st +++ b/src/Famix-Traits/FamixTGlobalVariable.trait.st @@ -6,18 +6,25 @@ FamixTGlobalVariable represents a global variable in the source code. ====================== ### Parents -- Relation: #parentScope Type: #FamixTWithGlobalVariables Opposite: #globalVariables Comment: Scope declaring the global variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentScope` | `FamixTGlobalVariable` | `globalVariables` | `FamixTWithGlobalVariables` | Scope declaring the global variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTHasImmediateSource.trait.st b/src/Famix-Traits/FamixTHasImmediateSource.trait.st index 3c79a008..d1131c87 100644 --- a/src/Famix-Traits/FamixTHasImmediateSource.trait.st +++ b/src/Famix-Traits/FamixTHasImmediateSource.trait.st @@ -5,12 +5,15 @@ An immediate source is the source code of the entity stored directly into its so ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Trait { diff --git a/src/Famix-Traits/FamixTHasKind.trait.st b/src/Famix-Traits/FamixTHasKind.trait.st index c82f7f9a..a433cb74 100644 --- a/src/Famix-Traits/FamixTHasKind.trait.st +++ b/src/Famix-Traits/FamixTHasKind.trait.st @@ -4,7 +4,8 @@ This is an indicator that a method is a setter, getter, constant, or constructor ## Properties ====================== -- Named: #kind Type: String Comment: Tag indicating a setter, getter, constant, constructor method +| Name | Type | Default value | Comment | +| `kind` | `String` | nil | Tag indicating a setter, getter, constant, constructor method| " Trait { diff --git a/src/Famix-Traits/FamixTHasSignature.trait.st b/src/Famix-Traits/FamixTHasSignature.trait.st index 4f4fbd99..0a63dd8d 100644 --- a/src/Famix-Traits/FamixTHasSignature.trait.st +++ b/src/Famix-Traits/FamixTHasSignature.trait.st @@ -4,7 +4,8 @@ The signature of any behavioural entity ## Properties ====================== -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `signature` | `String` | nil | Signature of the message being sent| " Trait { diff --git a/src/Famix-Traits/FamixTHasVisibility.trait.st b/src/Famix-Traits/FamixTHasVisibility.trait.st index 7fc2f74f..c9599055 100644 --- a/src/Famix-Traits/FamixTHasVisibility.trait.st +++ b/src/Famix-Traits/FamixTHasVisibility.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #visibility Type: String Comment: Visibility of the entity +| Name | Type | Default value | Comment | +| `visibility` | `String` | nil | Visibility of the entity| " Trait { diff --git a/src/Famix-Traits/FamixTHeader.trait.st b/src/Famix-Traits/FamixTHeader.trait.st index 3cd7d602..907a54bf 100644 --- a/src/Famix-Traits/FamixTHeader.trait.st +++ b/src/Famix-Traits/FamixTHeader.trait.st @@ -5,10 +5,14 @@ I represent a header file. Typically a .h or .hpp ====================== ### Parents -- Relation: #headerOwner Type: #FamixTWithHeaders Opposite: #header -- Relation: #parentFolder Type: #FamixTFolder Opposite: #childrenFileSystemEntities Comment: Folder entity containing this file. +| Relation | Origin | Opposite | Type | Comment | +| `headerOwner` | `FamixTHeader` | `header` | `FamixTWithHeaders` | | +| `parentFolder` | `FamixTFileSystemEntity` | `childrenFileSystemEntities` | `FamixTFolder` | Folder entity containing this file.| + ### Other -- Relation: #entities Type: #FamixTWithFiles Opposite: #containerFiles Comment: List of entities defined in the file +| Relation | Origin | Opposite | Type | Comment | +| `entities` | `FamixTFile` | `containerFiles` | `FamixTWithFiles` | List of entities defined in the file| + " diff --git a/src/Famix-Traits/FamixTImplementable.trait.st b/src/Famix-Traits/FamixTImplementable.trait.st index bdf7d2aa..b36deffc 100644 --- a/src/Famix-Traits/FamixTImplementable.trait.st +++ b/src/Famix-Traits/FamixTImplementable.trait.st @@ -5,7 +5,9 @@ I can be the target of an implementation cf Interface ====================== ### Incoming dependencies -- Relation: #implementations Type: #FamixTImplementation Opposite: #interface Comment: Implementation relationships. +| Relation | Origin | Opposite | Type | Comment | +| `implementations` | `FamixTImplementable` | `interface` | `FamixTImplementation` | Implementation relationships.| + " diff --git a/src/Famix-Traits/FamixTImplementation.trait.st b/src/Famix-Traits/FamixTImplementation.trait.st index 2d2851e0..1c3d6d19 100644 --- a/src/Famix-Traits/FamixTImplementation.trait.st +++ b/src/Famix-Traits/FamixTImplementation.trait.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #implementingClass Type: #FamixTCanImplement Opposite: #interfaceImplementations Comment: Class linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `implementingClass` | `FamixTImplementation` | `interfaceImplementations` | `FamixTCanImplement` | Class linked to in this relationship. from-side of the association| + ### Association target -- Relation: #interface Type: #FamixTImplementable Opposite: #implementations Comment: Interface linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `interface` | `FamixTImplementation` | `implementations` | `FamixTImplementable` | Interface linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTImplicitVariable.trait.st b/src/Famix-Traits/FamixTImplicitVariable.trait.st index f832df4a..dda81143 100644 --- a/src/Famix-Traits/FamixTImplicitVariable.trait.st +++ b/src/Famix-Traits/FamixTImplicitVariable.trait.st @@ -5,18 +5,25 @@ FamixTImplicitVariable represents a variable defined by the compiler in a contex ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithImplicitVariables Opposite: #implicitVariables Comment: The behaviour containing this implicit variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTImplicitVariable` | `implicitVariables` | `FamixTWithImplicitVariables` | The behaviour containing this implicit variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTImport.trait.st b/src/Famix-Traits/FamixTImport.trait.st index 8db2b9c0..1ddf867d 100644 --- a/src/Famix-Traits/FamixTImport.trait.st +++ b/src/Famix-Traits/FamixTImport.trait.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #importingEntity Type: #FamixTWithImports Opposite: #outgoingImports Comment: Importing entity +| Relation | Origin | Opposite | Type | Comment | +| `importingEntity` | `FamixTImport` | `outgoingImports` | `FamixTWithImports` | Importing entity| + ### Association target -- Relation: #importedEntity Type: #FamixTImportable Opposite: #incomingImports Comment: Imported entity +| Relation | Origin | Opposite | Type | Comment | +| `importedEntity` | `FamixTImport` | `incomingImports` | `FamixTImportable` | Imported entity| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTImportable.trait.st b/src/Famix-Traits/FamixTImportable.trait.st index 5946d7d3..3bfbde0f 100644 --- a/src/Famix-Traits/FamixTImportable.trait.st +++ b/src/Famix-Traits/FamixTImportable.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingImports Type: #FamixTImport Opposite: #importedEntity Comment: List of imports of this entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingImports` | `FamixTImportable` | `importedEntity` | `FamixTImport` | List of imports of this entity| + " diff --git a/src/Famix-Traits/FamixTIndexedFileNavigation.trait.st b/src/Famix-Traits/FamixTIndexedFileNavigation.trait.st index 7251e8ce..52925a17 100644 --- a/src/Famix-Traits/FamixTIndexedFileNavigation.trait.st +++ b/src/Famix-Traits/FamixTIndexedFileNavigation.trait.st @@ -2,11 +2,12 @@ ## Properties ====================== -- Named: #correspondingFile Type: FamixTFile Comment: File associated to this source anchor -- Named: #encoding Type: String Comment: A string representing the encoding of a file -- Named: #endPos Type: Number Comment: Stop position in the source -- Named: #fileName Type: String Comment: Name of the source file -- Named: #startPos Type: Number Comment: Start position in the source +| Name | Type | Default value | Comment | +| `correspondingFile` | `FamixTFile` | nil | File associated to this source anchor| +| `encoding` | `String` | nil | A string representing the encoding of a file| +| `endPos` | `Number` | nil | Stop position in the source| +| `fileName` | `String` | nil | Name of the source file| +| `startPos` | `Number` | nil | Start position in the source| " Trait { diff --git a/src/Famix-Traits/FamixTInheritance.trait.st b/src/Famix-Traits/FamixTInheritance.trait.st index 5400c280..27b7af81 100644 --- a/src/Famix-Traits/FamixTInheritance.trait.st +++ b/src/Famix-Traits/FamixTInheritance.trait.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #subclass Type: #FamixTWithInheritances Opposite: #superInheritances Comment: Subclass linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `subclass` | `FamixTInheritance` | `superInheritances` | `FamixTWithInheritances` | Subclass linked to in this relationship. from-side of the association| + ### Association target -- Relation: #superclass Type: #FamixTWithInheritances Opposite: #subInheritances Comment: Superclass linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `superclass` | `FamixTInheritance` | `subInheritances` | `FamixTWithInheritances` | Superclass linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTInvocable.trait.st b/src/Famix-Traits/FamixTInvocable.trait.st index 9e15a599..a159cf61 100644 --- a/src/Famix-Traits/FamixTInvocable.trait.st +++ b/src/Famix-Traits/FamixTInvocable.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + " diff --git a/src/Famix-Traits/FamixTInvocation.trait.st b/src/Famix-Traits/FamixTInvocation.trait.st index cf187769..0bdb8eaa 100644 --- a/src/Famix-Traits/FamixTInvocation.trait.st +++ b/src/Famix-Traits/FamixTInvocation.trait.st @@ -14,20 +14,27 @@ will produce one invocation association from current method to a variable anObje ====================== ### Association source -- Relation: #sender Type: #FamixTWithInvocations Opposite: #outgoingInvocations Comment: Behavioural entity making the call. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `sender` | `FamixTInvocation` | `outgoingInvocations` | `FamixTWithInvocations` | Behavioural entity making the call. from-side of the association| + ### Association target -- Relation: #candidates Type: #FamixTInvocable Opposite: #incomingInvocations Comment: List of candidate behavioural entities for receiving the invocation +| Relation | Origin | Opposite | Type | Comment | +| `candidates` | `FamixTInvocation` | `incomingInvocations` | `FamixTInvocable` | List of candidate behavioural entities for receiving the invocation| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #receiver Type: #FamixTInvocationsReceiver Opposite: #receivingInvocations Comment: Named entity (variable, class...) receiving the invocation. to-side of the association -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `receiver` | `FamixTInvocation` | `receivingInvocations` | `FamixTInvocationsReceiver` | Named entity (variable, class...) receiving the invocation. to-side of the association| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `signature` | `String` | nil | Signature of the message being sent| " Trait { diff --git a/src/Famix-Traits/FamixTInvocationsReceiver.trait.st b/src/Famix-Traits/FamixTInvocationsReceiver.trait.st index cd5b567c..7fb58faf 100644 --- a/src/Famix-Traits/FamixTInvocationsReceiver.trait.st +++ b/src/Famix-Traits/FamixTInvocationsReceiver.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) +| Relation | Origin | Opposite | Type | Comment | +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| + " diff --git a/src/Famix-Traits/FamixTLocalVariable.trait.st b/src/Famix-Traits/FamixTLocalVariable.trait.st index f2791df7..55c6cca4 100644 --- a/src/Famix-Traits/FamixTLocalVariable.trait.st +++ b/src/Famix-Traits/FamixTLocalVariable.trait.st @@ -5,18 +5,25 @@ FamixTLocalVariable represents a local variable in the scope of a behavioural en ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithLocalVariables Opposite: #localVariables Comment: Behavioural entity declaring this local variable. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTLocalVariable` | `localVariables` | `FamixTWithLocalVariables` | Behavioural entity declaring this local variable. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTMethod.trait.st b/src/Famix-Traits/FamixTMethod.trait.st index 91878a58..e1c13a6b 100644 --- a/src/Famix-Traits/FamixTMethod.trait.st +++ b/src/Famix-Traits/FamixTMethod.trait.st @@ -7,27 +7,38 @@ A FamixTMethod is always contained in a parentType. ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Trait { diff --git a/src/Famix-Traits/FamixTModule.trait.st b/src/Famix-Traits/FamixTModule.trait.st index 57263286..339a5a1f 100644 --- a/src/Famix-Traits/FamixTModule.trait.st +++ b/src/Famix-Traits/FamixTModule.trait.st @@ -6,7 +6,9 @@ FamixTModule represents a that basically provides a simple scoping abstraction f ====================== ### Children -- Relation: #moduleEntities Type: #FamixTDefinedInModule Opposite: #parentModule +| Relation | Origin | Opposite | Type | Comment | +| `moduleEntities` | `FamixTModule` | `parentModule` | `FamixTDefinedInModule` | | + " diff --git a/src/Famix-Traits/FamixTMultipleFileAnchor.trait.st b/src/Famix-Traits/FamixTMultipleFileAnchor.trait.st index d9f58739..cdd0c2ab 100644 --- a/src/Famix-Traits/FamixTMultipleFileAnchor.trait.st +++ b/src/Famix-Traits/FamixTMultipleFileAnchor.trait.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #fileAnchors Type: FamixTFileAnchor Comment: All source code definition files +| Name | Type | Default value | Comment | +| `fileAnchors` | `FamixTFileAnchor` | nil | All source code definition files| " Trait { diff --git a/src/Famix-Traits/FamixTNamedEntity.trait.st b/src/Famix-Traits/FamixTNamedEntity.trait.st index fbab4a1c..6e27b75a 100644 --- a/src/Famix-Traits/FamixTNamedEntity.trait.st +++ b/src/Famix-Traits/FamixTNamedEntity.trait.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTNamespace.trait.st b/src/Famix-Traits/FamixTNamespace.trait.st index 4c41256a..d37a0f11 100644 --- a/src/Famix-Traits/FamixTNamespace.trait.st +++ b/src/Famix-Traits/FamixTNamespace.trait.st @@ -9,13 +9,16 @@ When an entity is placed inside a namespace, the fully qualified name (mooseName ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTPackage.trait.st b/src/Famix-Traits/FamixTPackage.trait.st index ea89215d..c6f9d672 100644 --- a/src/Famix-Traits/FamixTPackage.trait.st +++ b/src/Famix-Traits/FamixTPackage.trait.st @@ -7,15 +7,20 @@ Java extractors map Java packages to FamixTNamespaces. They can also mirror the ====================== ### Children -- Relation: #childEntities Type: #FamixTPackageable Opposite: #parentPackage +| Relation | Origin | Opposite | Type | Comment | +| `childEntities` | `FamixTPackage` | `parentPackage` | `FamixTPackageable` | | + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTPackageable.trait.st b/src/Famix-Traits/FamixTPackageable.trait.st index 780414fc..c6e920d5 100644 --- a/src/Famix-Traits/FamixTPackageable.trait.st +++ b/src/Famix-Traits/FamixTPackageable.trait.st @@ -3,7 +3,9 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| + " diff --git a/src/Famix-Traits/FamixTParameter.trait.st b/src/Famix-Traits/FamixTParameter.trait.st index 7f5c0f5f..eb3ab49b 100644 --- a/src/Famix-Traits/FamixTParameter.trait.st +++ b/src/Famix-Traits/FamixTParameter.trait.st @@ -15,18 +15,25 @@ int addNumbers(int a, int b) { ====================== ### Parents -- Relation: #parentBehaviouralEntity Type: #FamixTWithParameters Opposite: #parameters Comment: Behavioural entity containing this parameter. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentBehaviouralEntity` | `FamixTParameter` | `parameters` | `FamixTWithParameters` | Behavioural entity containing this parameter. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTParameterizedType.trait.st b/src/Famix-Traits/FamixTParameterizedType.trait.st index a3e58a82..5311b1d1 100644 --- a/src/Famix-Traits/FamixTParameterizedType.trait.st +++ b/src/Famix-Traits/FamixTParameterizedType.trait.st @@ -12,7 +12,9 @@ Where Map is the FamixTParameterizedType of anAttribute. Stri ====================== ### Other -- Relation: #parameterizableClass Type: #FamixTWithParameterizedTypes Opposite: #parameterizedTypes Comment: Base type of this parameterized type. +| Relation | Origin | Opposite | Type | Comment | +| `parameterizableClass` | `FamixTParameterizedType` | `parameterizedTypes` | `FamixTWithParameterizedTypes` | Base type of this parameterized type.| + " diff --git a/src/Famix-Traits/FamixTParameterizedTypeUser.trait.st b/src/Famix-Traits/FamixTParameterizedTypeUser.trait.st index 2916fe33..92268818 100644 --- a/src/Famix-Traits/FamixTParameterizedTypeUser.trait.st +++ b/src/Famix-Traits/FamixTParameterizedTypeUser.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #argumentsInParameterizedTypes Type: #FamixTWithParameterizedTypeUsers Opposite: #arguments +| Relation | Origin | Opposite | Type | Comment | +| `argumentsInParameterizedTypes` | `FamixTParameterizedTypeUser` | `arguments` | `FamixTWithParameterizedTypeUsers` | | + " diff --git a/src/Famix-Traits/FamixTPrimitiveType.trait.st b/src/Famix-Traits/FamixTPrimitiveType.trait.st index 11780d68..1b910927 100644 --- a/src/Famix-Traits/FamixTPrimitiveType.trait.st +++ b/src/Famix-Traits/FamixTPrimitiveType.trait.st @@ -3,18 +3,25 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTReference.trait.st b/src/Famix-Traits/FamixTReference.trait.st index b3c7debb..08ba7003 100644 --- a/src/Famix-Traits/FamixTReference.trait.st +++ b/src/Famix-Traits/FamixTReference.trait.st @@ -15,18 +15,25 @@ Note that FamixTReference was defined between two FamixTContainerEntity entities ====================== ### Association source -- Relation: #referencer Type: #FamixTWithReferences Opposite: #outgoingReferences Comment: Source entity making the reference. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referencer` | `FamixTReference` | `outgoingReferences` | `FamixTWithReferences` | Source entity making the reference. from-side of the association| + ### Association target -- Relation: #referredType Type: #FamixTReferenceable Opposite: #incomingReferences Comment: Target entity referenced. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `referredType` | `FamixTReference` | `incomingReferences` | `FamixTReferenceable` | Target entity referenced. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTReferenceable.trait.st b/src/Famix-Traits/FamixTReferenceable.trait.st index 6f0e1092..e233d152 100644 --- a/src/Famix-Traits/FamixTReferenceable.trait.st +++ b/src/Famix-Traits/FamixTReferenceable.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + " diff --git a/src/Famix-Traits/FamixTRelativeSourceAnchor.trait.st b/src/Famix-Traits/FamixTRelativeSourceAnchor.trait.st index 83b11f4d..d08c07ed 100644 --- a/src/Famix-Traits/FamixTRelativeSourceAnchor.trait.st +++ b/src/Famix-Traits/FamixTRelativeSourceAnchor.trait.st @@ -19,14 +19,17 @@ Internal Representation and Key Implementation Points. ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #endPos Type: Number Comment: Stop position in the source -- Named: #relatedAnchor Type: FamixTSourceAnchor Comment: Source anchor to which I am relative. -- Named: #startPos Type: Number Comment: Start position in the source +| Name | Type | Default value | Comment | +| `endPos` | `Number` | nil | Stop position in the source| +| `relatedAnchor` | `FamixTSourceAnchor` | nil | Source anchor to which I am relative.| +| `startPos` | `Number` | nil | Start position in the source| " Trait { diff --git a/src/Famix-Traits/FamixTSourceAnchor.trait.st b/src/Famix-Traits/FamixTSourceAnchor.trait.st index 9bb2ffcd..ef39d849 100644 --- a/src/Famix-Traits/FamixTSourceAnchor.trait.st +++ b/src/Famix-Traits/FamixTSourceAnchor.trait.st @@ -5,7 +5,9 @@ FamixTSourceAnchor is an abstract class representing a pointer to a source. The ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Famix-Traits/FamixTSourceEntity.trait.st b/src/Famix-Traits/FamixTSourceEntity.trait.st index f66d0007..4727fb3c 100644 --- a/src/Famix-Traits/FamixTSourceEntity.trait.st +++ b/src/Famix-Traits/FamixTSourceEntity.trait.st @@ -5,12 +5,15 @@ FamixTSourcedEntity models any fact in a program source and it is the superclass ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTSourceLanguage.trait.st b/src/Famix-Traits/FamixTSourceLanguage.trait.st index f02a0e00..dd5dd78f 100644 --- a/src/Famix-Traits/FamixTSourceLanguage.trait.st +++ b/src/Famix-Traits/FamixTSourceLanguage.trait.st @@ -8,7 +8,9 @@ One can create a default source language for a project by not associating any en ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Traits/FamixTStructuralEntity.trait.st b/src/Famix-Traits/FamixTStructuralEntity.trait.st index fce5a001..81128def 100644 --- a/src/Famix-Traits/FamixTStructuralEntity.trait.st +++ b/src/Famix-Traits/FamixTStructuralEntity.trait.st @@ -5,16 +5,21 @@ FamixTStructuralEntity is the abstract superclass for basic data structure in th ====================== ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTTemplate.trait.st b/src/Famix-Traits/FamixTTemplate.trait.st index d30ace61..5cc0988e 100644 --- a/src/Famix-Traits/FamixTTemplate.trait.st +++ b/src/Famix-Traits/FamixTTemplate.trait.st @@ -3,9 +3,13 @@ ====================== ### Parents -- Relation: #templateOwner Type: #FamixTWithTemplates Opposite: #templates +| Relation | Origin | Opposite | Type | Comment | +| `templateOwner` | `FamixTTemplate` | `templates` | `FamixTWithTemplates` | | + ### Other -- Relation: #templateUsers Type: #FamixTTemplateUser Opposite: #template +| Relation | Origin | Opposite | Type | Comment | +| `templateUsers` | `FamixTTemplate` | `template` | `FamixTTemplateUser` | | + " diff --git a/src/Famix-Traits/FamixTTemplateUser.trait.st b/src/Famix-Traits/FamixTTemplateUser.trait.st index 9ba45db1..521aaed9 100644 --- a/src/Famix-Traits/FamixTTemplateUser.trait.st +++ b/src/Famix-Traits/FamixTTemplateUser.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #template Type: #FamixTTemplate Opposite: #templateUsers +| Relation | Origin | Opposite | Type | Comment | +| `template` | `FamixTTemplateUser` | `templateUsers` | `FamixTTemplate` | | + " diff --git a/src/Famix-Traits/FamixTTrait.trait.st b/src/Famix-Traits/FamixTTrait.trait.st index 3074207a..671a0606 100644 --- a/src/Famix-Traits/FamixTTrait.trait.st +++ b/src/Famix-Traits/FamixTTrait.trait.st @@ -5,9 +5,13 @@ FamixTTrait models a trait as it can be found in Pharo or PHP. ====================== ### Parents -- Relation: #traitOwner Type: #FamixTWithTraits Opposite: #traits +| Relation | Origin | Opposite | Type | Comment | +| `traitOwner` | `FamixTTrait` | `traits` | `FamixTWithTraits` | | + ### Outgoing dependencies -- Relation: #incomingTraitUsages Type: #FamixTTraitUsage Opposite: #trait +| Relation | Origin | Opposite | Type | Comment | +| `incomingTraitUsages` | `FamixTTrait` | `trait` | `FamixTTraitUsage` | | + " diff --git a/src/Famix-Traits/FamixTTraitUsage.trait.st b/src/Famix-Traits/FamixTTraitUsage.trait.st index e82f6bbc..cafbc4d8 100644 --- a/src/Famix-Traits/FamixTTraitUsage.trait.st +++ b/src/Famix-Traits/FamixTTraitUsage.trait.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #trait Type: #FamixTTrait Opposite: #incomingTraitUsages +| Relation | Origin | Opposite | Type | Comment | +| `trait` | `FamixTTraitUsage` | `incomingTraitUsages` | `FamixTTrait` | | + ### Association target -- Relation: #user Type: #FamixTTraitUser Opposite: #outgoingTraitUsages +| Relation | Origin | Opposite | Type | Comment | +| `user` | `FamixTTraitUsage` | `outgoingTraitUsages` | `FamixTTraitUser` | | + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTTraitUser.trait.st b/src/Famix-Traits/FamixTTraitUser.trait.st index a9122bd2..67966a55 100644 --- a/src/Famix-Traits/FamixTTraitUser.trait.st +++ b/src/Famix-Traits/FamixTTraitUser.trait.st @@ -3,7 +3,9 @@ ====================== ### Incoming dependencies -- Relation: #outgoingTraitUsages Type: #FamixTTraitUsage Opposite: #user +| Relation | Origin | Opposite | Type | Comment | +| `outgoingTraitUsages` | `FamixTTraitUser` | `user` | `FamixTTraitUsage` | | + " diff --git a/src/Famix-Traits/FamixTType.trait.st b/src/Famix-Traits/FamixTType.trait.st index 48d1d0c5..aed9d079 100644 --- a/src/Famix-Traits/FamixTType.trait.st +++ b/src/Famix-Traits/FamixTType.trait.st @@ -9,18 +9,25 @@ A type can have multiple subtypes or supertypes. These are modelled by means of ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTTypeAlias.trait.st b/src/Famix-Traits/FamixTTypeAlias.trait.st index 84fec2cd..7cc3ada2 100644 --- a/src/Famix-Traits/FamixTTypeAlias.trait.st +++ b/src/Famix-Traits/FamixTTypeAlias.trait.st @@ -8,7 +8,9 @@ Instance Variables: ====================== ### Other -- Relation: #aliasedType Type: #FamixTWithTypeAliases Opposite: #typeAliases Comment: Points to the actual type. +| Relation | Origin | Opposite | Type | Comment | +| `aliasedType` | `FamixTTypeAlias` | `typeAliases` | `FamixTWithTypeAliases` | Points to the actual type.| + " diff --git a/src/Famix-Traits/FamixTTypedAnnotationInstance.trait.st b/src/Famix-Traits/FamixTTypedAnnotationInstance.trait.st index a04a60de..bc059971 100644 --- a/src/Famix-Traits/FamixTTypedAnnotationInstance.trait.st +++ b/src/Famix-Traits/FamixTTypedAnnotationInstance.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #annotationType Type: #FamixTAnnotationType Opposite: #instances Comment: Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). +| Relation | Origin | Opposite | Type | Comment | +| `annotationType` | `FamixTTypedAnnotationInstance` | `instances` | `FamixTAnnotationType` | Refers to the type of an annotation. (In some languages, Java and C#, an annotation as an explicit type). | + " diff --git a/src/Famix-Traits/FamixTTypedAnnotationInstanceAttribute.trait.st b/src/Famix-Traits/FamixTTypedAnnotationInstanceAttribute.trait.st index ccfe7a9b..df25a389 100644 --- a/src/Famix-Traits/FamixTTypedAnnotationInstanceAttribute.trait.st +++ b/src/Famix-Traits/FamixTTypedAnnotationInstanceAttribute.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #annotationTypeAttribute Type: #FamixTAnnotationTypeAttribute Opposite: #annotationAttributeInstances Comment: This corresponds to the type of the attribute in an AnnotationInstance +| Relation | Origin | Opposite | Type | Comment | +| `annotationTypeAttribute` | `FamixTTypedAnnotationInstanceAttribute` | `annotationAttributeInstances` | `FamixTAnnotationTypeAttribute` | This corresponds to the type of the attribute in an AnnotationInstance| + " diff --git a/src/Famix-Traits/FamixTTypedEntity.trait.st b/src/Famix-Traits/FamixTTypedEntity.trait.st index bd35d455..47ec89fb 100644 --- a/src/Famix-Traits/FamixTTypedEntity.trait.st +++ b/src/Famix-Traits/FamixTTypedEntity.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| + " diff --git a/src/Famix-Traits/FamixTUnknownSourceLanguage.trait.st b/src/Famix-Traits/FamixTUnknownSourceLanguage.trait.st index 0f39b4e8..2d283676 100644 --- a/src/Famix-Traits/FamixTUnknownSourceLanguage.trait.st +++ b/src/Famix-Traits/FamixTUnknownSourceLanguage.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Famix-Traits/FamixTUnknownVariable.trait.st b/src/Famix-Traits/FamixTUnknownVariable.trait.st index bc775b5c..721d47f4 100644 --- a/src/Famix-Traits/FamixTUnknownVariable.trait.st +++ b/src/Famix-Traits/FamixTUnknownVariable.trait.st @@ -3,16 +3,21 @@ ====================== ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Trait { diff --git a/src/Famix-Traits/FamixTWithAccesses.trait.st b/src/Famix-Traits/FamixTWithAccesses.trait.st index 28e28335..484615bd 100644 --- a/src/Famix-Traits/FamixTWithAccesses.trait.st +++ b/src/Famix-Traits/FamixTWithAccesses.trait.st @@ -3,7 +3,9 @@ ====================== ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| + " diff --git a/src/Famix-Traits/FamixTWithAnnotationInstanceAttributes.trait.st b/src/Famix-Traits/FamixTWithAnnotationInstanceAttributes.trait.st index 50bb0b8d..b83b56d7 100644 --- a/src/Famix-Traits/FamixTWithAnnotationInstanceAttributes.trait.st +++ b/src/Famix-Traits/FamixTWithAnnotationInstanceAttributes.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #attributes Type: #FamixTAnnotationInstanceAttribute Opposite: #parentAnnotationInstance Comment: This corresponds to the actual values of the attributes in an AnnotationInstance +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAnnotationInstanceAttributes` | `parentAnnotationInstance` | `FamixTAnnotationInstanceAttribute` | This corresponds to the actual values of the attributes in an AnnotationInstance| + " diff --git a/src/Famix-Traits/FamixTWithAnnotationInstances.trait.st b/src/Famix-Traits/FamixTWithAnnotationInstances.trait.st index 17ba79bc..997af8ce 100644 --- a/src/Famix-Traits/FamixTWithAnnotationInstances.trait.st +++ b/src/Famix-Traits/FamixTWithAnnotationInstances.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #annotationInstances Type: #FamixTAnnotationInstance Opposite: #annotatedEntity Comment: This property corresponds to the set of annotations associated to the entity +| Relation | Origin | Opposite | Type | Comment | +| `annotationInstances` | `FamixTWithAnnotationInstances` | `annotatedEntity` | `FamixTAnnotationInstance` | This property corresponds to the set of annotations associated to the entity| + " diff --git a/src/Famix-Traits/FamixTWithAnnotationTypes.trait.st b/src/Famix-Traits/FamixTWithAnnotationTypes.trait.st index 88bf7553..6d9f396b 100644 --- a/src/Famix-Traits/FamixTWithAnnotationTypes.trait.st +++ b/src/Famix-Traits/FamixTWithAnnotationTypes.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #definedAnnotationTypes Type: #FamixTAnnotationType Opposite: #annotationTypesContainer Comment: The container in which the AnnotationTypes may be declared +| Relation | Origin | Opposite | Type | Comment | +| `definedAnnotationTypes` | `FamixTWithAnnotationTypes` | `annotationTypesContainer` | `FamixTAnnotationType` | The container in which the AnnotationTypes may be declared| + " diff --git a/src/Famix-Traits/FamixTWithAttributes.trait.st b/src/Famix-Traits/FamixTWithAttributes.trait.st index 4fc87c8c..d20f3c5e 100644 --- a/src/Famix-Traits/FamixTWithAttributes.trait.st +++ b/src/Famix-Traits/FamixTWithAttributes.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| + " diff --git a/src/Famix-Traits/FamixTWithClasses.trait.st b/src/Famix-Traits/FamixTWithClasses.trait.st index 744b00c5..d7b27ea9 100644 --- a/src/Famix-Traits/FamixTWithClasses.trait.st +++ b/src/Famix-Traits/FamixTWithClasses.trait.st @@ -3,8 +3,10 @@ ====================== ### Children -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + " diff --git a/src/Famix-Traits/FamixTWithComments.trait.st b/src/Famix-Traits/FamixTWithComments.trait.st index 57f3bc22..bf7f3be8 100644 --- a/src/Famix-Traits/FamixTWithComments.trait.st +++ b/src/Famix-Traits/FamixTWithComments.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| + " diff --git a/src/Famix-Traits/FamixTWithCompilationUnits.trait.st b/src/Famix-Traits/FamixTWithCompilationUnits.trait.st index cdf452b2..1ed73362 100644 --- a/src/Famix-Traits/FamixTWithCompilationUnits.trait.st +++ b/src/Famix-Traits/FamixTWithCompilationUnits.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #compilationUnit Type: #FamixTCompilationUnit Opposite: #compilationUnitOwner +| Relation | Origin | Opposite | Type | Comment | +| `compilationUnit` | `FamixTWithCompilationUnits` | `compilationUnitOwner` | `FamixTCompilationUnit` | | + " diff --git a/src/Famix-Traits/FamixTWithDereferencedInvocations.trait.st b/src/Famix-Traits/FamixTWithDereferencedInvocations.trait.st index 4a089455..e0e12dea 100644 --- a/src/Famix-Traits/FamixTWithDereferencedInvocations.trait.st +++ b/src/Famix-Traits/FamixTWithDereferencedInvocations.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #dereferencedInvocations Type: #FamixTDereferencedInvocation Opposite: #referencer Comment: List of invocations performed on BehaviouralEntities referenced by this entity +| Relation | Origin | Opposite | Type | Comment | +| `dereferencedInvocations` | `FamixTWithDereferencedInvocations` | `referencer` | `FamixTDereferencedInvocation` | List of invocations performed on BehaviouralEntities referenced by this entity| + " diff --git a/src/Famix-Traits/FamixTWithEnumValues.trait.st b/src/Famix-Traits/FamixTWithEnumValues.trait.st index 446cd99c..0c46516f 100644 --- a/src/Famix-Traits/FamixTWithEnumValues.trait.st +++ b/src/Famix-Traits/FamixTWithEnumValues.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #enumValues Type: #FamixTEnumValue Opposite: #parentEnum +| Relation | Origin | Opposite | Type | Comment | +| `enumValues` | `FamixTWithEnumValues` | `parentEnum` | `FamixTEnumValue` | | + " diff --git a/src/Famix-Traits/FamixTWithExceptions.trait.st b/src/Famix-Traits/FamixTWithExceptions.trait.st index d8a7bdb4..0aaa055e 100644 --- a/src/Famix-Traits/FamixTWithExceptions.trait.st +++ b/src/Famix-Traits/FamixTWithExceptions.trait.st @@ -3,9 +3,11 @@ ====================== ### Other -- Relation: #caughtExceptions Type: #FamixTException Opposite: #catchingEntities Comment: The exceptions caught by the method -- Relation: #declaredExceptions Type: #FamixTException Opposite: #declaringEntities Comment: The exceptions declared by the method -- Relation: #thrownExceptions Type: #FamixTException Opposite: #throwingEntities Comment: The exceptions thrown by the method +| Relation | Origin | Opposite | Type | Comment | +| `caughtExceptions` | `FamixTWithExceptions` | `catchingEntities` | `FamixTException` | The exceptions caught by the method| +| `declaredExceptions` | `FamixTWithExceptions` | `declaringEntities` | `FamixTException` | The exceptions declared by the method| +| `thrownExceptions` | `FamixTWithExceptions` | `throwingEntities` | `FamixTException` | The exceptions thrown by the method| + " diff --git a/src/Famix-Traits/FamixTWithFileIncludes.trait.st b/src/Famix-Traits/FamixTWithFileIncludes.trait.st index 151d8aae..e7975ab8 100644 --- a/src/Famix-Traits/FamixTWithFileIncludes.trait.st +++ b/src/Famix-Traits/FamixTWithFileIncludes.trait.st @@ -3,8 +3,10 @@ ====================== ### Other -- Relation: #incomingIncludeRelations Type: #FamixTFileInclude Opposite: #target Comment: The include entities that have this file as a target. -- Relation: #outgoingIncludeRelations Type: #FamixTFileInclude Opposite: #source Comment: The include entities that have this file as a source. +| Relation | Origin | Opposite | Type | Comment | +| `incomingIncludeRelations` | `FamixTWithFileIncludes` | `target` | `FamixTFileInclude` | The include entities that have this file as a target.| +| `outgoingIncludeRelations` | `FamixTWithFileIncludes` | `source` | `FamixTFileInclude` | The include entities that have this file as a source.| + " diff --git a/src/Famix-Traits/FamixTWithFiles.trait.st b/src/Famix-Traits/FamixTWithFiles.trait.st index ab199a0d..824e71f0 100644 --- a/src/Famix-Traits/FamixTWithFiles.trait.st +++ b/src/Famix-Traits/FamixTWithFiles.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #containerFiles Type: #FamixTFile Opposite: #entities Comment: List of files containing the entity +| Relation | Origin | Opposite | Type | Comment | +| `containerFiles` | `FamixTWithFiles` | `entities` | `FamixTFile` | List of files containing the entity| + " diff --git a/src/Famix-Traits/FamixTWithFunctions.trait.st b/src/Famix-Traits/FamixTWithFunctions.trait.st index 595993a1..2efa51c5 100644 --- a/src/Famix-Traits/FamixTWithFunctions.trait.st +++ b/src/Famix-Traits/FamixTWithFunctions.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #functions Type: #FamixTFunction Opposite: #functionOwner Comment: Functions defined in the container, if any. +| Relation | Origin | Opposite | Type | Comment | +| `functions` | `FamixTWithFunctions` | `functionOwner` | `FamixTFunction` | Functions defined in the container, if any.| + " diff --git a/src/Famix-Traits/FamixTWithGlobalVariables.trait.st b/src/Famix-Traits/FamixTWithGlobalVariables.trait.st index 2526f3f7..ca3cf975 100644 --- a/src/Famix-Traits/FamixTWithGlobalVariables.trait.st +++ b/src/Famix-Traits/FamixTWithGlobalVariables.trait.st @@ -5,7 +5,9 @@ A container having Global variables ====================== ### Children -- Relation: #globalVariables Type: #FamixTGlobalVariable Opposite: #parentScope Comment: Global variables defined in the scope, if any. +| Relation | Origin | Opposite | Type | Comment | +| `globalVariables` | `FamixTWithGlobalVariables` | `parentScope` | `FamixTGlobalVariable` | Global variables defined in the scope, if any.| + " diff --git a/src/Famix-Traits/FamixTWithHeaders.trait.st b/src/Famix-Traits/FamixTWithHeaders.trait.st index 454a92d0..8fa5c56d 100644 --- a/src/Famix-Traits/FamixTWithHeaders.trait.st +++ b/src/Famix-Traits/FamixTWithHeaders.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #header Type: #FamixTHeader Opposite: #headerOwner Comment: The header file that defines this module +| Relation | Origin | Opposite | Type | Comment | +| `header` | `FamixTWithHeaders` | `headerOwner` | `FamixTHeader` | The header file that defines this module| + " diff --git a/src/Famix-Traits/FamixTWithImplicitVariables.trait.st b/src/Famix-Traits/FamixTWithImplicitVariables.trait.st index 9b696ea9..35c9d5ba 100644 --- a/src/Famix-Traits/FamixTWithImplicitVariables.trait.st +++ b/src/Famix-Traits/FamixTWithImplicitVariables.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `implicitVariables` | `FamixTWithImplicitVariables` | `parentBehaviouralEntity` | `FamixTImplicitVariable` | Implicit variables used locally by this behaviour.| + " diff --git a/src/Famix-Traits/FamixTWithImports.trait.st b/src/Famix-Traits/FamixTWithImports.trait.st index 3509f29d..f051eb1e 100644 --- a/src/Famix-Traits/FamixTWithImports.trait.st +++ b/src/Famix-Traits/FamixTWithImports.trait.st @@ -3,7 +3,9 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingImports Type: #FamixTImport Opposite: #importingEntity +| Relation | Origin | Opposite | Type | Comment | +| `outgoingImports` | `FamixTWithImports` | `importingEntity` | `FamixTImport` | | + " diff --git a/src/Famix-Traits/FamixTWithInheritances.trait.st b/src/Famix-Traits/FamixTWithInheritances.trait.st index 1b54ef2f..48c703b5 100644 --- a/src/Famix-Traits/FamixTWithInheritances.trait.st +++ b/src/Famix-Traits/FamixTWithInheritances.trait.st @@ -3,9 +3,13 @@ ====================== ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + " diff --git a/src/Famix-Traits/FamixTWithInvocations.trait.st b/src/Famix-Traits/FamixTWithInvocations.trait.st index 1300a79e..f5b5e8ca 100644 --- a/src/Famix-Traits/FamixTWithInvocations.trait.st +++ b/src/Famix-Traits/FamixTWithInvocations.trait.st @@ -3,7 +3,9 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| + " diff --git a/src/Famix-Traits/FamixTWithLocalVariables.trait.st b/src/Famix-Traits/FamixTWithLocalVariables.trait.st index a19ee649..83e12889 100644 --- a/src/Famix-Traits/FamixTWithLocalVariables.trait.st +++ b/src/Famix-Traits/FamixTWithLocalVariables.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `localVariables` | `FamixTWithLocalVariables` | `parentBehaviouralEntity` | `FamixTLocalVariable` | Variables locally defined by this behaviour.| + " diff --git a/src/Famix-Traits/FamixTWithMethods.trait.st b/src/Famix-Traits/FamixTWithMethods.trait.st index 7ad24d62..e5315884 100644 --- a/src/Famix-Traits/FamixTWithMethods.trait.st +++ b/src/Famix-Traits/FamixTWithMethods.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + " diff --git a/src/Famix-Traits/FamixTWithParameterizedTypeUsers.trait.st b/src/Famix-Traits/FamixTWithParameterizedTypeUsers.trait.st index 8e391ca0..c3522423 100644 --- a/src/Famix-Traits/FamixTWithParameterizedTypeUsers.trait.st +++ b/src/Famix-Traits/FamixTWithParameterizedTypeUsers.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #arguments Type: #FamixTParameterizedTypeUser Opposite: #argumentsInParameterizedTypes +| Relation | Origin | Opposite | Type | Comment | +| `arguments` | `FamixTWithParameterizedTypeUsers` | `argumentsInParameterizedTypes` | `FamixTParameterizedTypeUser` | | + " diff --git a/src/Famix-Traits/FamixTWithParameterizedTypes.trait.st b/src/Famix-Traits/FamixTWithParameterizedTypes.trait.st index 757b2f19..f3d24c57 100644 --- a/src/Famix-Traits/FamixTWithParameterizedTypes.trait.st +++ b/src/Famix-Traits/FamixTWithParameterizedTypes.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #parameterizedTypes Type: #FamixTParameterizedType Opposite: #parameterizableClass +| Relation | Origin | Opposite | Type | Comment | +| `parameterizedTypes` | `FamixTWithParameterizedTypes` | `parameterizableClass` | `FamixTParameterizedType` | | + " diff --git a/src/Famix-Traits/FamixTWithParameters.trait.st b/src/Famix-Traits/FamixTWithParameters.trait.st index 3869b285..54fb4e9d 100644 --- a/src/Famix-Traits/FamixTWithParameters.trait.st +++ b/src/Famix-Traits/FamixTWithParameters.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `parameters` | `FamixTWithParameters` | `parentBehaviouralEntity` | `FamixTParameter` | List of formal parameters declared by this behaviour.| + " diff --git a/src/Famix-Traits/FamixTWithReferences.trait.st b/src/Famix-Traits/FamixTWithReferences.trait.st index 1f0598f1..abd0dbb9 100644 --- a/src/Famix-Traits/FamixTWithReferences.trait.st +++ b/src/Famix-Traits/FamixTWithReferences.trait.st @@ -3,7 +3,9 @@ ====================== ### Outgoing dependencies -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + " diff --git a/src/Famix-Traits/FamixTWithSourceLanguages.trait.st b/src/Famix-Traits/FamixTWithSourceLanguages.trait.st index 2c731f93..a9769ead 100644 --- a/src/Famix-Traits/FamixTWithSourceLanguages.trait.st +++ b/src/Famix-Traits/FamixTWithSourceLanguages.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #declaredSourceLanguage Type: #FamixTSourceLanguage Opposite: #sourcedEntities Comment: The declared SourceLanguage for the source code of this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredSourceLanguage` | `FamixTWithSourceLanguages` | `sourcedEntities` | `FamixTSourceLanguage` | The declared SourceLanguage for the source code of this entity| + " diff --git a/src/Famix-Traits/FamixTWithStatements.trait.st b/src/Famix-Traits/FamixTWithStatements.trait.st index 77664ce1..e63af7d0 100644 --- a/src/Famix-Traits/FamixTWithStatements.trait.st +++ b/src/Famix-Traits/FamixTWithStatements.trait.st @@ -3,16 +3,21 @@ ====================== ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Trait { diff --git a/src/Famix-Traits/FamixTWithTemplates.trait.st b/src/Famix-Traits/FamixTWithTemplates.trait.st index 61296637..49eade2e 100644 --- a/src/Famix-Traits/FamixTWithTemplates.trait.st +++ b/src/Famix-Traits/FamixTWithTemplates.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #templates Type: #FamixTTemplate Opposite: #templateOwner +| Relation | Origin | Opposite | Type | Comment | +| `templates` | `FamixTWithTemplates` | `templateOwner` | `FamixTTemplate` | | + " diff --git a/src/Famix-Traits/FamixTWithTraits.trait.st b/src/Famix-Traits/FamixTWithTraits.trait.st index ca6880f7..ec80175b 100644 --- a/src/Famix-Traits/FamixTWithTraits.trait.st +++ b/src/Famix-Traits/FamixTWithTraits.trait.st @@ -3,7 +3,9 @@ ====================== ### Children -- Relation: #traits Type: #FamixTTrait Opposite: #traitOwner +| Relation | Origin | Opposite | Type | Comment | +| `traits` | `FamixTWithTraits` | `traitOwner` | `FamixTTrait` | | + " diff --git a/src/Famix-Traits/FamixTWithTypeAliases.trait.st b/src/Famix-Traits/FamixTWithTypeAliases.trait.st index 3e53e990..26f96ee9 100644 --- a/src/Famix-Traits/FamixTWithTypeAliases.trait.st +++ b/src/Famix-Traits/FamixTWithTypeAliases.trait.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #typeAliases Type: #FamixTTypeAlias Opposite: #aliasedType Comment: Aliases +| Relation | Origin | Opposite | Type | Comment | +| `typeAliases` | `FamixTWithTypeAliases` | `aliasedType` | `FamixTTypeAlias` | Aliases| + " diff --git a/src/Famix-Traits/FamixTWithTypes.trait.st b/src/Famix-Traits/FamixTWithTypes.trait.st index e166574e..bca8c1c7 100644 --- a/src/Famix-Traits/FamixTWithTypes.trait.st +++ b/src/Famix-Traits/FamixTWithTypes.trait.st @@ -3,8 +3,10 @@ ====================== ### Children -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + " diff --git a/src/FamixDocumentor-TestMetaModel/FDClass1.class.st b/src/FamixDocumentor-TestMetaModel/FDClass1.class.st index e7384272..d9047c8a 100644 --- a/src/FamixDocumentor-TestMetaModel/FDClass1.class.st +++ b/src/FamixDocumentor-TestMetaModel/FDClass1.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #myTrait Type: #FDTrait4 Opposite: #class1 +| Relation | Origin | Opposite | Type | Comment | +| `myTrait` | `FDClass1` | `class1` | `FDTrait4` | | + " diff --git a/src/FamixDocumentor-TestMetaModel/FDTrait4.trait.st b/src/FamixDocumentor-TestMetaModel/FDTrait4.trait.st index 3e6cccd8..6e78e350 100644 --- a/src/FamixDocumentor-TestMetaModel/FDTrait4.trait.st +++ b/src/FamixDocumentor-TestMetaModel/FDTrait4.trait.st @@ -3,13 +3,16 @@ ====================== ### Other -- Relation: #class1 Type: #FDClass1 Opposite: #myTrait +| Relation | Origin | Opposite | Type | Comment | +| `class1` | `FDTrait4` | `myTrait` | `FDClass1` | | + ## Properties ====================== -- Named: #otherProp Type: Object Comment: Another property in the trait -- Named: #someProp Type: String Comment: A property in the trait +| Name | Type | Default value | Comment | +| `otherProp` | `Object` | nil | Another property in the trait| +| `someProp` | `String` | nil | A property in the trait| " Trait { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestAttribute.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestAttribute.class.st index 21059b30..eecd4d32 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestAttribute.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestAttribute.class.st @@ -3,18 +3,25 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithAttributes Opposite: #attributes Comment: Type declaring the attribute. belongsTo implementation +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation| + ### Incoming dependencies -- Relation: #incomingAccesses Type: #FamixTAccess Opposite: #variable Comment: All Famix accesses pointing to this structural entity +| Relation | Origin | Opposite | Type | Comment | +| `incomingAccesses` | `FamixTAccessible` | `variable` | `FamixTAccess` | All Famix accesses pointing to this structural entity| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestClass.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestClass.class.st index 80e3656b..65ad14bc 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestClass.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestClass.class.st @@ -3,26 +3,37 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Children -- Relation: #attributes Type: #FamixTAttribute Opposite: #parentType Comment: List of attributes declared by this type. -- Relation: #methods Type: #FamixTMethod Opposite: #parentType Comment: Methods declared by this type. +| Relation | Origin | Opposite | Type | Comment | +| `attributes` | `FamixTWithAttributes` | `parentType` | `FamixTAttribute` | List of attributes declared by this type.| +| `methods` | `FamixTWithMethods` | `parentType` | `FamixTMethod` | Methods declared by this type.| + ### Outgoing dependencies -- Relation: #superInheritances Type: #FamixTInheritance Opposite: #subclass Comment: Superinheritance relationships, i.e. known superclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `superInheritances` | `FamixTWithInheritances` | `subclass` | `FamixTInheritance` | Superinheritance relationships, i.e. known superclasses of this type.| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. -- Relation: #subInheritances Type: #FamixTInheritance Opposite: #superclass Comment: Subinheritance relationships, i.e. known subclasses of this type. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| +| `subInheritances` | `FamixTWithInheritances` | `superclass` | `FamixTInheritance` | Subinheritance relationships, i.e. known subclasses of this type.| + ### Other -- Relation: #comments Type: #FamixTComment Opposite: #commentedEntity Comment: List of comments for the entity -- Relation: #receivingInvocations Type: #FamixTInvocation Opposite: #receiver Comment: List of invocations performed on this entity (considered as the receiver) -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `comments` | `FamixTWithComments` | `commentedEntity` | `FamixTComment` | List of comments for the entity| +| `receivingInvocations` | `FamixTInvocationsReceiver` | `receiver` | `FamixTInvocation` | List of invocations performed on this entity (considered as the receiver)| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestComment.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestComment.class.st index 2982bce2..dd24be74 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestComment.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestComment.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #commentedEntity Type: #FamixTWithComments Opposite: #comments Comment: Source code commented by the comment +| Relation | Origin | Opposite | Type | Comment | +| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment| + ## Properties ====================== -- Named: #content Type: String Comment: Content of the comment as a String +| Name | Type | Default value | Comment | +| `content` | `String` | nil | Content of the comment as a String| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestInheritance.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestInheritance.class.st index 4d0fb2da..e71a3046 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestInheritance.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestInheritance.class.st @@ -3,18 +3,25 @@ ====================== ### Association source -- Relation: #subclass Type: #FamixTWithInheritances Opposite: #superInheritances Comment: Subclass linked to in this relationship. from-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `subclass` | `FamixTInheritance` | `superInheritances` | `FamixTWithInheritances` | Subclass linked to in this relationship. from-side of the association| + ### Association target -- Relation: #superclass Type: #FamixTWithInheritances Opposite: #subInheritances Comment: Superclass linked to in this relationship. to-side of the association +| Relation | Origin | Opposite | Type | Comment | +| `superclass` | `FamixTInheritance` | `subInheritances` | `FamixTWithInheritances` | Superclass linked to in this relationship. to-side of the association| + ### Other -- Relation: #next Type: #FamixTAssociation Opposite: #previous Comment: Next association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #previous Type: #FamixTAssociation Opposite: #next Comment: Previous association in an ordered collection of associations. Currently not supported by the Moose importer -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `next` | `FamixTAssociation` | `previous` | `FamixTAssociation` | Next association in an ordered collection of associations. Currently not supported by the Moose importer| +| `previous` | `FamixTAssociation` | `next` | `FamixTAssociation` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestMethod.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestMethod.class.st index 39046ecd..d6370015 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestMethod.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestMethod.class.st @@ -3,27 +3,38 @@ ====================== ### Parents -- Relation: #parentType Type: #FamixTWithMethods Opposite: #methods Comment: Type declaring the method. It provides the implementation for belongsTo. +| Relation | Origin | Opposite | Type | Comment | +| `parentType` | `FamixTMethod` | `methods` | `FamixTWithMethods` | Type declaring the method. It provides the implementation for belongsTo.| + ### Children -- Relation: #implicitVariables Type: #FamixTImplicitVariable Opposite: #parentBehaviouralEntity Comment: Implicit variables used locally by this behaviour. -- Relation: #localVariables Type: #FamixTLocalVariable Opposite: #parentBehaviouralEntity Comment: Variables locally defined by this behaviour. -- Relation: #parameters Type: #FamixTParameter Opposite: #parentBehaviouralEntity Comment: List of formal parameters declared by this behaviour. +| Relation | Origin | Opposite | Type | Comment | +| `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.| + ### Outgoing dependencies -- Relation: #accesses Type: #FamixTAccess Opposite: #accessor Comment: Accesses to variables made by this behaviour. -- Relation: #outgoingInvocations Type: #FamixTInvocation Opposite: #sender Comment: Outgoing invocations sent by this behaviour. -- Relation: #outgoingReferences Type: #FamixTReference Opposite: #referencer Comment: References from this entity to other entities. +| Relation | Origin | Opposite | Type | Comment | +| `accesses` | `FamixTWithAccesses` | `accessor` | `FamixTAccess` | Accesses to variables made by this behaviour.| +| `outgoingInvocations` | `FamixTWithInvocations` | `sender` | `FamixTInvocation` | Outgoing invocations sent by this behaviour.| +| `outgoingReferences` | `FamixTWithReferences` | `referencer` | `FamixTReference` | References from this entity to other entities.| + ### Incoming dependencies -- Relation: #incomingInvocations Type: #FamixTInvocation Opposite: #candidates Comment: Incoming invocations from other behaviours computed by the candidate operator. +| Relation | Origin | Opposite | Type | Comment | +| `incomingInvocations` | `FamixTInvocable` | `candidates` | `FamixTInvocation` | Incoming invocations from other behaviours computed by the candidate operator.| + ### Other -- Relation: #declaredType Type: #FamixTType Opposite: #typedEntities Comment: Type of the entity, if any -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `declaredType` | `FamixTTypedEntity` | `typedEntities` | `FamixTType` | Type of the entity, if any| +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. -- Named: #signature Type: String Comment: Signature of the message being sent +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| +| `signature` | `String` | nil | Signature of the message being sent| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamedEntity.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamedEntity.class.st index 5661b883..72dc8a6c 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamedEntity.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamedEntity.class.st @@ -2,7 +2,8 @@ ## Properties ====================== -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamespace.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamespace.class.st index d05ddb4e..ab3ed79d 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamespace.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestNamespace.class.st @@ -3,16 +3,21 @@ ====================== ### Children -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPackage.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPackage.class.st index 8ee79393..770dfa21 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPackage.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPackage.class.st @@ -3,19 +3,26 @@ ====================== ### Parents -- Relation: #parentPackage Type: #FamixTPackage Opposite: #childEntities Comment: Package containing the entity in the code structure (if applicable) +| Relation | Origin | Opposite | Type | Comment | +| `parentPackage` | `FamixTPackageable` | `childEntities` | `FamixTPackage` | Package containing the entity in the code structure (if applicable)| + ### Children -- Relation: #childEntities Type: #FamixTPackageable Opposite: #parentPackage -- Relation: #types Type: #FamixTType Opposite: #typeContainer Comment: Types contained (declared) in this entity, if any. -#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. +| Relation | Origin | Opposite | Type | Comment | +| `childEntities` | `FamixTPackage` | `parentPackage` | `FamixTPackageable` | | +| `types` | `FamixTWithTypes` | `typeContainer` | `FamixTType` | Types contained (declared) in this entity, if any. +#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.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPrimitiveType.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPrimitiveType.class.st index 318f9e4f..f18db16e 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPrimitiveType.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestPrimitiveType.class.st @@ -3,18 +3,25 @@ ====================== ### Parents -- Relation: #typeContainer Type: #FamixTWithTypes Opposite: #types Comment: Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk). +| Relation | Origin | Opposite | Type | Comment | +| `typeContainer` | `FamixTType` | `types` | `FamixTWithTypes` | Container entity to which this type belongs. Container is a namespace, not a package (Smalltalk).| + ### Incoming dependencies -- Relation: #incomingReferences Type: #FamixTReference Opposite: #referredType Comment: References to this entity by other entities. +| Relation | Origin | Opposite | Type | Comment | +| `incomingReferences` | `FamixTReferenceable` | `referredType` | `FamixTReference` | References to this entity by other entities.| + ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity -- Relation: #typedEntities Type: #FamixTTypedEntity Opposite: #declaredType Comment: Entities that have this type as declaredType +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| +| `typedEntities` | `FamixTType` | `declaredType` | `FamixTTypedEntity` | Entities that have this type as declaredType| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. -- Named: #name Type: String Comment: Basic name of the entity, not full reference. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| +| `name` | `String` | nil | Basic name of the entity, not full reference.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceAnchor.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceAnchor.class.st index 27d48402..24182b17 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceAnchor.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceAnchor.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + " diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceLanguage.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceLanguage.class.st index a87df9f2..2c6a4d74 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceLanguage.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + " diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceTextAnchor.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceTextAnchor.class.st index e4fefd01..365f1546 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceTextAnchor.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourceTextAnchor.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #element Type: #FamixTSourceEntity Opposite: #sourceAnchor Comment: Enable the accessibility to the famix entity that this class is a source pointer for +| Relation | Origin | Opposite | Type | Comment | +| `element` | `FamixTSourceAnchor` | `sourceAnchor` | `FamixTSourceEntity` | Enable the accessibility to the famix entity that this class is a source pointer for| + ## Properties ====================== -- Named: #source Type: String Comment: Actual source code of the source entity +| Name | Type | Default value | Comment | +| `source` | `String` | nil | Actual source code of the source entity| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourcedEntity.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourcedEntity.class.st index 9139c7ba..dbeed914 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourcedEntity.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestSourcedEntity.class.st @@ -3,12 +3,15 @@ ====================== ### Other -- Relation: #sourceAnchor Type: #FamixTSourceAnchor Opposite: #element Comment: SourceAnchor entity linking to the original source code for this entity +| Relation | Origin | Opposite | Type | Comment | +| `sourceAnchor` | `FamixTSourceEntity` | `element` | `FamixTSourceAnchor` | SourceAnchor entity linking to the original source code for this entity| + ## Properties ====================== -- Named: #isStub Type: Boolean Comment: Flag true if the entity attributes are incomplete, either because the entity is missing or not imported. +| Name | Type | Default value | Comment | +| `isStub` | `Boolean` | false | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.| " Class { diff --git a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestUnknownSourceLanguage.class.st b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestUnknownSourceLanguage.class.st index a9326ddc..6a1594f1 100644 --- a/src/Moose-Core-Tests-Entities/MooseMSEImporterTestUnknownSourceLanguage.class.st +++ b/src/Moose-Core-Tests-Entities/MooseMSEImporterTestUnknownSourceLanguage.class.st @@ -3,7 +3,9 @@ ====================== ### Other -- Relation: #sourcedEntities Type: #FamixTWithSourceLanguages Opposite: #declaredSourceLanguage Comment: References to the entities saying explicitly that are written in this language. +| Relation | Origin | Opposite | Type | Comment | +| `sourcedEntities` | `FamixTSourceLanguage` | `declaredSourceLanguage` | `FamixTWithSourceLanguages` | References to the entities saying explicitly that are written in this language.| + "