eclipse-aascw / aas-core-codegen / 36346142626

90%

push

github

Add visibility to functions and methods (#784)

We signal the visibility in the meta-model with the leading underscores,
following the Python conventions: ``_foo`` functions are internal,
``_foo`` methods protected and ``__foo`` methods private. This allows
us to introduce internal verification functions which are not visible
to the users of the generated SDKs.

The non-public methods serve only as helpers to the
implementation-specific methods, since the invariants live outside
the class in most targets. They are left out of the interfaces, the
enhancing wrappers and the generated tests.

The internal functions are rendered as ``internal static`` in C#,
``private static`` in Java, unexported in Go, not exported in
TypeScript, ``_foo`` in Python, and in the anonymous namespace of
``verification.cpp`` in C++.

We refuse the references to the non-public members, *e.g.*,
``:func:`_foo``` or ``:meth:`_bar```, in the public documentation, as
they would dangle for the users of the SDKs. In Go, we refuse
the internal functions whose unexported names collide with the ones we
generate, *e.g.*, ``verifyJsonValue``.

195 of 196 new or added lines in 30 files covered. (99.49%)

41124 of 46477 relevant lines covered (88.48%)

2.65 hits per line