Passthrough documentation in initializers.

Author: Paebbels

pyVHDLModel/SyntaxModel.py

@@ -1621,17 +1621,17 @@ class BaseConstant(Obj):
 
 @export
 class Constant(BaseConstant, WithDefaultExpressionMixin):
-	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype)
+	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, documentation)
 		WithDefaultExpressionMixin.__init__(self, defaultExpression)
 
 
 @export
 class DeferredConstant(BaseConstant):
 	_constantReference: Constant
 
-	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol):
-		super().__init__(identifiers, subtype)
+	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, documentation: str = None):
+		super().__init__(identifiers, subtype, documentation)
 
 	@property
 	def ConstantReference(self) -> Constant:
@@ -1640,8 +1640,8 @@ def ConstantReference(self) -> Constant:
 
 @export
 class Variable(Obj, WithDefaultExpressionMixin):
-	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype)
+	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, documentation)
 		WithDefaultExpressionMixin.__init__(self, defaultExpression)
 
 
@@ -1652,8 +1652,8 @@ class SharedVariable(Obj):
 
 @export
 class Signal(Obj, WithDefaultExpressionMixin):
-	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super(Signal, self).__init__(identifiers, subtype)
+	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, documentation)
 		WithDefaultExpressionMixin.__init__(self, defaultExpression)
 
 
@@ -1710,8 +1710,8 @@ class Procedure(SubProgramm):
 class Function(SubProgramm):
 	_returnType: Subtype
 
-	def __init__(self, identifier: str, isPure: bool = True):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, isPure: bool = True, documentation: str = None):
+		super().__init__(identifier, documentation)
 		self._isPure = isPure
 
 	@property
@@ -1839,16 +1839,16 @@ class ParameterInterfaceItem(InterfaceItem):
 
 @export
 class GenericConstantInterfaceItem(Constant, GenericInterfaceItem, InterfaceItemWithMode):
-	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype, defaultExpression)
+	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, defaultExpression, documentation)
 		GenericInterfaceItem.__init__(self)
 		InterfaceItemWithMode.__init__(self, mode)
 
 
 @export
 class GenericTypeInterfaceItem(Type, GenericInterfaceItem):
-	def __init__(self, identifier: str):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, documentation: str):
+		super().__init__(identifier, documentation)
 		GenericInterfaceItem.__init__(self)
 
 
@@ -1859,60 +1859,60 @@ class GenericSubprogramInterfaceItem(GenericInterfaceItem):
 
 @export
 class GenericProcedureInterfaceItem(Procedure, GenericInterfaceItem):
-	def __init__(self, identifier: str):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, documentation: str):
+		super().__init__(identifier, documentation)
 		GenericInterfaceItem.__init__(self)
 
 
 @export
 class GenericFunctionInterfaceItem(Function, GenericInterfaceItem):
-	def __init__(self, identifier: str):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, documentation: str):
+		super().__init__(identifier, documentation)
 		GenericInterfaceItem.__init__(self)
 
 
 @export
 class GenericPackageInterfaceItem(GenericInterfaceItem):
-	def __init__(self, identifier: str):
-		#	super().__init__(identifier)
+	def __init__(self, identifier: str, documentation: str):
+		#	super().__init__(identifier, documentation)
 		GenericInterfaceItem.__init__(self)
 
 
 @export
 class PortSignalInterfaceItem(Signal, PortInterfaceItem):
-	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype, defaultExpression)
+	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, defaultExpression, documentation)
 		PortInterfaceItem.__init__(self, mode)
 
 
 @export
 class ParameterConstantInterfaceItem(Constant, ParameterInterfaceItem, InterfaceItemWithMode):
-	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype, defaultExpression)
+	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, defaultExpression, documentation)
 		ParameterInterfaceItem.__init__(self)
 		InterfaceItemWithMode.__init__(self, mode)
 
 
 @export
 class ParameterVariableInterfaceItem(Variable, ParameterInterfaceItem, InterfaceItemWithMode):
-	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype, defaultExpression)
+	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, defaultExpression, documentation)
 		ParameterInterfaceItem.__init__(self)
 		InterfaceItemWithMode.__init__(self, mode)
 
 
 @export
 class ParameterSignalInterfaceItem(Signal, ParameterInterfaceItem, InterfaceItemWithMode):
-	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None):
-		super().__init__(identifiers, subtype, defaultExpression)
+	def __init__(self, identifiers: Iterable[str], mode: Mode, subtype: SubtypeOrSymbol, defaultExpression: ExpressionUnion = None, documentation: str = None):
+		super().__init__(identifiers, subtype, defaultExpression, documentation)
 		ParameterInterfaceItem.__init__(self)
 		InterfaceItemWithMode.__init__(self, mode)
 
 
 @export
 class ParameterFileInterfaceItem(File, ParameterInterfaceItem):
-	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol):
-		super().__init__(identifiers, subtype)
+	def __init__(self, identifiers: Iterable[str], subtype: SubtypeOrSymbol, documentation: str = None):
+		super().__init__(identifiers, subtype, documentation)
 		ParameterInterfaceItem.__init__(self)
 
 
@@ -1950,8 +1950,8 @@ class Context(PrimaryUnit):
 	_libraryReferences: List[LibraryClause]
 	_packageReferences: List[UseClause]
 
-	def __init__(self, identifier: str, libraryReferences: Iterable[LibraryClause] = None, packageReferences: Iterable[UseClause] = None):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, libraryReferences: Iterable[LibraryClause] = None, packageReferences: Iterable[UseClause] = None, documentation: str = None):
+		super().__init__(identifier, documentation)
 
 		self._libraryReferences = [] if libraryReferences is None else [l for l in libraryReferences]
 		self._packageReferences = [] if packageReferences is None else [p for p in packageReferences]
@@ -1980,9 +1980,10 @@ def __init__(
 		genericItems: Iterable[GenericInterfaceItem] = None,
 		portItems: Iterable[PortInterfaceItem] = None,
 		declaredItems: Iterable = None,
-		statements: Iterable['ConcurrentStatement'] = None
+		statements: Iterable['ConcurrentStatement'] = None,
+		documentation: str = None
 	):
-		super().__init__(identifier)
+		super().__init__(identifier, documentation)
 		MixinDesignUnitWithContext.__init__(self, contextItems)
 
 		self._genericItems  = [] if genericItems is None else [g for g in genericItems]
@@ -2019,8 +2020,8 @@ class Architecture(SecondaryUnit, MixinDesignUnitWithContext):
 	_declaredItems: List   # FIXME: define list prefix type e.g. via Union
 	_statements:    List['ConcurrentStatement']
 
-	def __init__(self, identifier: str, entity: Name, contextItems: Iterable[Context] = None, declaredItems: Iterable = None, statements: Iterable['ConcurrentStatement'] = None):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, entity: Name, contextItems: Iterable[Context] = None, declaredItems: Iterable = None, statements: Iterable['ConcurrentStatement'] = None, documentation: str = None):
+		super().__init__(identifier, documentation)
 		MixinDesignUnitWithContext.__init__(self, contextItems)
 
 		self._entity        = EntitySymbol(entity)
@@ -2048,13 +2049,14 @@ def Statements(self) -> List['ConcurrentStatement']:
 
 
 @export
-class Component(ModelEntity, NamedEntity):
+class Component(ModelEntity, NamedEntity, DocumentedEntity):
 	_genericItems:      List[GenericInterfaceItem]
 	_portItems:         List[PortInterfaceItem]
 
-	def __init__(self, identifier: str, genericItems: Iterable[GenericInterfaceItem] = None, portItems: Iterable[PortInterfaceItem] = None):
+	def __init__(self, identifier: str, genericItems: Iterable[GenericInterfaceItem] = None, portItems: Iterable[PortInterfaceItem] = None, documentation: str = None):
 		super().__init__()
 		NamedEntity.__init__(self, identifier)
+		DocumentedEntity.__init__(self, documentation)
 
 		self._genericItems      = [] if genericItems is None else [g for g in genericItems]
 		self._portItems         = [] if portItems is None else [p for p in portItems]
@@ -2070,8 +2072,8 @@ def PortItems(self) -> List[PortInterfaceItem]:
 
 @export
 class Configuration(PrimaryUnit, MixinDesignUnitWithContext):
-	def __init__(self, identifier: str, contextItems: Iterable[Context] = None):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, contextItems: Iterable[Context] = None, documentation: str = None):
+		super().__init__(identifier, documentation)
 		MixinDesignUnitWithContext.__init__(self, contextItems)
 
 
@@ -2145,8 +2147,8 @@ class Package(PrimaryUnit, MixinDesignUnitWithContext):
 	_genericItems:      List[GenericInterfaceItem]
 	_declaredItems:     List
 
-	def __init__(self, identifier: str, contextItems: Iterable[Context] = None, genericItems: Iterable[GenericInterfaceItem] = None, declaredItems: Iterable = None):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, contextItems: Iterable[Context] = None, genericItems: Iterable[GenericInterfaceItem] = None, declaredItems: Iterable = None, documentation: str = None):
+		super().__init__(identifier, documentation)
 		MixinDesignUnitWithContext.__init__(self, contextItems)
 
 		self._genericItems =  [] if genericItems is None else [g for g in genericItems]
@@ -2166,8 +2168,8 @@ class PackageBody(SecondaryUnit, MixinDesignUnitWithContext):
 	_package:           Package
 	_declaredItems:     List
 
-	def __init__(self, identifier: str, contextItems: Iterable[Context] = None, declaredItems: Iterable = None):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, contextItems: Iterable[Context] = None, declaredItems: Iterable = None, documentation: str = None):
+		super().__init__(identifier, documentation)
 		MixinDesignUnitWithContext.__init__(self, contextItems)
 
 		self._declaredItems = [] if declaredItems is None else [i for i in declaredItems]
@@ -2186,8 +2188,8 @@ class PackageInstantiation(PrimaryUnit, GenericEntityInstantiation):
 	_packageReference:    Package
 	_genericAssociations: List[GenericAssociationItem]
 
-	def __init__(self, identifier: str, uninstantiatedPackage: PackageOrSymbol):
-		super().__init__(identifier)
+	def __init__(self, identifier: str, uninstantiatedPackage: PackageOrSymbol, documentation: str = None):
+		super().__init__(identifier, documentation)
 		GenericEntityInstantiation.__init__(self)
 
 		self._packageReference = uninstantiatedPackage