Skip to content

Commit

Permalink
Add origin and default values
Browse files Browse the repository at this point in the history
  • Loading branch information
jecisc committed Jan 16, 2024
1 parent a0ea48c commit ca8d300
Show file tree
Hide file tree
Showing 304 changed files with 1,871 additions and 1,867 deletions.
4 changes: 2 additions & 2 deletions src/Famix-Deprecated/FamixTHasModifiers.trait.st
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
## Properties
======================
| Name | Type | Comment |
| `modifiers` | String | Generic container for language dependent modifiers.|
| Name | Type | Default value | Comment |
| `modifiers` | `String` | nil | Generic container for language dependent modifiers.|
"
Trait {
Expand Down
22 changes: 11 additions & 11 deletions src/Famix-Java-Entities/FamixJavaAccess.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,26 @@
======================
### Association source
| Relation | Type | Opposite | Comment |
| `accessor` | `FamixTWithAccesses` | `accesses` | 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 | Type | Opposite | Comment |
| `variable` | `FamixTAccessible` | `incomingAccesses` | 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 | Type | Opposite | Comment |
| `next` | `FamixTAssociation` | `previous` | Next association in an ordered collection of associations. Currently not supported by the Moose importer|
| `previous` | `FamixTAssociation` | `next` | Previous association in an ordered collection of associations. Currently not supported by the Moose importer|
| `sourceAnchor` | `FamixTSourceAnchor` | `element` | 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
======================
| Name | Type | Comment |
| `isStub` | Boolean | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
| `isWrite` | Boolean | 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 {
Expand Down
10 changes: 5 additions & 5 deletions src/Famix-Java-Entities/FamixJavaAnnotationInstance.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
======================
### Children
| Relation | Type | Opposite | Comment |
| `attributes` | `FamixTAnnotationInstanceAttribute` | `parentAnnotationInstance` | 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 | Type | Opposite | Comment |
| `annotatedEntity` | `FamixTWithAnnotationInstances` | `annotationInstances` | The NamedEntity on which the annotation occurs.|
| `annotationType` | `FamixTAnnotationType` | `instances` | 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). |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
======================
### Parents
| Relation | Type | Opposite | Comment |
| `parentAnnotationInstance` | `FamixTWithAnnotationInstanceAttributes` | `attributes` | 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 | Type | Opposite | Comment |
| `annotationTypeAttribute` | `FamixTAnnotationTypeAttribute` | `annotationAttributeInstances` | 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
======================
| Name | Type | Comment |
| `value` | String | 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 {
Expand Down
30 changes: 15 additions & 15 deletions src/Famix-Java-Entities/FamixJavaAnnotationType.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,34 @@
======================
### Parents
| Relation | Type | Opposite | Comment |
| `annotationTypesContainer` | `FamixTWithAnnotationTypes` | `definedAnnotationTypes` | Container in which an AnnotationType may reside|
| `parentPackage` | `FamixTPackage` | `childEntities` | 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 | Type | Opposite | Comment |
| `attributes` | `FamixTAttribute` | `parentType` | 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 | Type | Opposite | Comment |
| `superInheritances` | `FamixTInheritance` | `subclass` | 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 | Type | Opposite | Comment |
| `implementations` | `FamixTImplementation` | `interface` | Implementation relationships.|
| `subInheritances` | `FamixTInheritance` | `superclass` | 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 | Type | Opposite | Comment |
| `comments` | `FamixTComment` | `commentedEntity` | List of comments for the entity|
| `instances` | `FamixTTypedAnnotationInstance` | `annotationType` | 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
======================
| Name | Type | Comment |
| `visibility` | String | Visibility of the entity|
| Name | Type | Default value | Comment |
| `visibility` | `String` | nil | Visibility of the entity|
"
Class {
Expand Down
26 changes: 13 additions & 13 deletions src/Famix-Java-Entities/FamixJavaAnnotationTypeAttribute.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,28 @@
======================
### Parents
| Relation | Type | Opposite | Comment |
| `parentType` | `FamixTWithAttributes` | `attributes` | Type declaring the attribute. belongsTo implementation|
| Relation | Origin | Opposite | Type | Comment |
| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation|
### Incoming dependencies
| Relation | Type | Opposite | Comment |
| `incomingAccesses` | `FamixTAccess` | `variable` | 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 | Type | Opposite | Comment |
| `annotationAttributeInstances` | `FamixTTypedAnnotationInstanceAttribute` | `annotationTypeAttribute` | A collection of AnnotationInstanceAttribute which hold the usages of this attribute in actual AnnotationInstances|
| `annotationTypeAttribute` | `FamixTAnnotationTypeAttribute` | `annotationAttributeInstances` | This corresponds to the type of the attribute in an AnnotationInstance|
| `comments` | `FamixTComment` | `commentedEntity` | List of comments for the entity|
| `declaredType` | `FamixTType` | `typedEntities` | Type of the entity, if any|
| `sourceAnchor` | `FamixTSourceAnchor` | `element` | 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
======================
| Name | Type | Comment |
| `isStub` | Boolean | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
| `name` | String | 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 {
Expand Down
34 changes: 17 additions & 17 deletions src/Famix-Java-Entities/FamixJavaAttribute.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,32 @@
======================
### Parents
| Relation | Type | Opposite | Comment |
| `parentType` | `FamixTWithAttributes` | `attributes` | Type declaring the attribute. belongsTo implementation|
| Relation | Origin | Opposite | Type | Comment |
| `parentType` | `FamixTAttribute` | `attributes` | `FamixTWithAttributes` | Type declaring the attribute. belongsTo implementation|
### Incoming dependencies
| Relation | Type | Opposite | Comment |
| `incomingAccesses` | `FamixTAccess` | `variable` | 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 | Type | Opposite | Comment |
| `comments` | `FamixTComment` | `commentedEntity` | List of comments for the entity|
| `declaredType` | `FamixTType` | `typedEntities` | Type of the entity, if any|
| `receivingInvocations` | `FamixTInvocation` | `receiver` | List of invocations performed on this entity (considered as the receiver)|
| `sourceAnchor` | `FamixTSourceAnchor` | `element` | 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
======================
| Name | Type | Comment |
| `isClassSide` | Boolean | Entity can be declared class side i.e. static|
| `isFinal` | Boolean | Entity can be declared final|
| `isStub` | Boolean | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
| `isTransient` | Boolean | Entity can be declared transient|
| `isVolatile` | Boolean | Entity can be declared volatile|
| `name` | String | Basic name of the entity, not full reference.|
| `visibility` | String | 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 {
Expand Down
52 changes: 26 additions & 26 deletions src/Famix-Java-Entities/FamixJavaClass.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,45 @@
======================
### Parents
| Relation | Type | Opposite | Comment |
| `parentPackage` | `FamixTPackage` | `childEntities` | Package containing the entity in the code structure (if applicable)|
| `typeContainer` | `FamixTWithTypes` | `types` | 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 | Type | Opposite | Comment |
| `attributes` | `FamixTAttribute` | `parentType` | List of attributes declared by this type.|
| `methods` | `FamixTMethod` | `parentType` | 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 | Type | Opposite | Comment |
| `interfaceImplementations` | `FamixTImplementation` | `implementingClass` | Implementation relationships|
| `outgoingImports` | `FamixTImport` | `importingEntity` | |
| `superInheritances` | `FamixTInheritance` | `subclass` | 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 | Type | Opposite | Comment |
| `incomingImports` | `FamixTImport` | `importedEntity` | List of imports of this entity|
| `incomingReferences` | `FamixTReference` | `referredType` | References to this entity by other entities.|
| `subInheritances` | `FamixTInheritance` | `superclass` | 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 | Type | Opposite | Comment |
| `comments` | `FamixTComment` | `commentedEntity` | List of comments for the entity|
| `receivingInvocations` | `FamixTInvocation` | `receiver` | List of invocations performed on this entity (considered as the receiver)|
| `sourceAnchor` | `FamixTSourceAnchor` | `element` | SourceAnchor entity linking to the original source code for this entity|
| `typedEntities` | `FamixTTypedEntity` | `declaredType` | 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
======================
| Name | Type | Comment |
| `isAbstract` | Boolean | Entity can be declared abstract|
| `isClassSide` | Boolean | Entity can be declared class side i.e. static|
| `isFinal` | Boolean | Entity can be declared final|
| `isStub` | Boolean | Flag true if the entity attributes are incomplete, either because the entity is missing or not imported.|
| `name` | String | Basic name of the entity, not full reference.|
| `visibility` | String | 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 {
Expand Down
8 changes: 4 additions & 4 deletions src/Famix-Java-Entities/FamixJavaComment.class.st
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
======================
### Other
| Relation | Type | Opposite | Comment |
| `commentedEntity` | `FamixTWithComments` | `comments` | Source code commented by the comment|
| Relation | Origin | Opposite | Type | Comment |
| `commentedEntity` | `FamixTComment` | `comments` | `FamixTWithComments` | Source code commented by the comment|
## Properties
======================
| Name | Type | Comment |
| `content` | String | Content of the comment as a String|
| Name | Type | Default value | Comment |
| `content` | `String` | nil | Content of the comment as a String|
"
Class {
Expand Down
Loading

0 comments on commit ca8d300

Please sign in to comment.