Documentation SysML

class Documentation

Implementation of Documentation defined in the KerML specification.

Specification:

Documentation is a Comment that specifically documents a documented_element, which must be its owner.

For language description, see section 7.2.4.2 of the KerML specification. For more details on the model, see section 8.3.2.3.5 of the KerML specification.

Inheritance:

• AstNode

• Element

• AnnotatingElement

• Comment

• Documentation

Members defined in Documentation (2 members)

	STD	R	All subtypes of Documentation according to the specification.
	documented_element	R SysML	Implementation of documented_element defined in the KerML specification.

Members inherited from Comment (2 members)

	body	RW SysML	Implementation of body defined in the KerML specification.
	locale	RW SysML	Implementation of locale defined in the KerML specification.

Members inherited from AnnotatingElement (5 members)

	about	R	Container for owned annotations.
	annotated_elements	R SysML	Implementation of annotated_element defined in the KerML specification.
	annotations	R SysML	Implementation of annotation defined in the KerML specification.
	owned_annotating_relationships	R SysML	Implementation of owned_annotating_relationship defined in the KerML specification.
	owning_annotating_relationship	R SysML	Implementation of owning_annotating_relationship defined in the KerML specification.

Members inherited from Element (25 members)

	alias_ids	R SysML	Implementation of alias_ids defined in the KerML specification.
	comments	R	The owned Comments related by owned_relationships.
	declared_name	RW SysML	Implementation of declared_name defined in the KerML specification.
	declared_short_name	RW SysML	Implementation of declared_short_name defined in the KerML specification.
	documentation	R SysML	Implementation of documentation defined in the KerML specification.
	element_id	RW SysML	Implementation of element_id defined in the KerML specification.
	is_implied_included	R SysML	Implementation of is_implied_included defined in the KerML specification.
	is_library_element	R SysML	Implementation of is_library_element defined in the KerML specification.
	metadata	R	The owned metadata related by owned_relationships.
	name	R SysML	Implementation of name defined in the KerML specification.
	owned_annotations	R SysML	Implementation of owned_annotation defined in the KerML specification.
	owned_elements	R SysML	Implementation of owned_element defined in the KerML specification.
	owned_relationships	R SysML	Implementation of owned_relationship defined in the KerML specification.
	owner	R SysML	Implementation of owner defined in the KerML specification.
	owning_membership	R SysML	Implementation of owning_membership defined in the KerML specification.
	owning_namespace	R SysML	Implementation of owning_namespace defined in the KerML specification.
	owning_relationship	R SysML	Implementation of owning_relationship defined in the KerML specification.
	path	R	Return a unique description of the location of this Element in the containment structure rooted in a root Namespace. In most cases the segments will be identical to QualifiedName.
	qualified_name	R SysML	Implementation of qualified_name defined in the KerML specification.
	scoped_owner	R	The owner of this Element as the parent of owning_membership or owning_relationship otherwise.
	sema_state	RW	The state of semantic resolution for this Element. Based on this, sema may skip elements to avoid duplicate work, e.g. when resolving elements in a group of related documents.
	short_name	R SysML	Implementation of short_name defined in the KerML specification.
	textual_representations	R SysML	Implementation of textual_representation defined in the KerML specification.
	__str__
	matches_qualified_name		Check if the qualified name of this Element matches the provided segments of a qualified name.

Members inherited from AstNode (7 members)

	cst_node	R	The source CST node of self if one exists.
	document	R	The document that owns this node.
	parent	R	The parent node of self.
	__hash__		Identity based hash of this node.
	cast		cast(self, *type: type[TNode]) -> TNode
	isinstance		Chainable equivalent to isintance(self, type)
	try_cast		Checked cast to type.

Attributes

STD: tuple[type[syside.Documentation], ...] = Ellipsis

All subtypes of Documentation according to the specification.

This is needed because the implementation does not use multiple inheritance like the standard metamodel. However, all would-be inherited attributes are implemented explicitly on classes in Documentation.Std.

When working with standard metamodel types, use:

if isinstance(element, Documentation.STD):
    ...

For type hints, instead use Documentation.Std:

def function(element: Element) -> Documentation.Std:
    ...

Note that Documentation.Std is only defined during TYPE_CHECKING, depending on the Python version used either from __future__ import annotations or def function(...) -> "Documentation.Std" may be required to ensure that annotations are resolved lazily without an actual object present.

property documented_element: syside.Element | None

Implementation of documented_element defined in the KerML specification.

Specification:

The Element that is documented by this Documentation.

See section 8.3.2.3.5 of the KerML specification for more details.

Used in

• syside.Documentation

  • STD

• syside.Element

  • documentation