diff options
Diffstat (limited to 'docs/source/pyasn1/type/namedtype')
4 files changed, 33 insertions, 8 deletions
diff --git a/docs/source/pyasn1/type/namedtype/defaultednamedtype.rst b/docs/source/pyasn1/type/namedtype/defaultednamedtype.rst index e617288..f203d08 100644 --- a/docs/source/pyasn1/type/namedtype/defaultednamedtype.rst +++ b/docs/source/pyasn1/type/namedtype/defaultednamedtype.rst @@ -3,7 +3,7 @@ .. |NamedType| replace:: DefaultedNamedType -|NamedType| +DefaultedNamedType ------------------ .. autoclass:: pyasn1.type.namedtype.DefaultedNamedType @@ -11,4 +11,10 @@ .. note:: - The |NamedType| class models named field of a constructed ASN.1 type which has a default value. + The *DefaultedNamedType* class models named field of a constructed + ASN.1 type which has a default value. + + The *DefaultedNamedType* objects are normally utilized + by the :ref:`NamedTypes <namedtype.NamedTypes>` objects + to model individual fields of the constructed ASN.1 + types. diff --git a/docs/source/pyasn1/type/namedtype/namedtype.rst b/docs/source/pyasn1/type/namedtype/namedtype.rst index 2e6c270..7429ffa 100644 --- a/docs/source/pyasn1/type/namedtype/namedtype.rst +++ b/docs/source/pyasn1/type/namedtype/namedtype.rst @@ -3,12 +3,18 @@ .. |NamedType| replace:: NamedType -|NamedType| ------------ +NamedType +--------- .. autoclass:: pyasn1.type.namedtype.NamedType :members: .. note:: - The |NamedType| class models a mandatory field of a constructed ASN.1 type. + The *NamedType* class models a mandatory field of a constructed + ASN.1 type. + + The *NamedType* objects are normally utilized by the + the :ref:`NamedTypes <namedtype.NamedTypes>` objects + to model individual fields of the constructed ASN.1 + types. diff --git a/docs/source/pyasn1/type/namedtype/namedtypes.rst b/docs/source/pyasn1/type/namedtype/namedtypes.rst index d6ca43a..2e2bb9d 100644 --- a/docs/source/pyasn1/type/namedtype/namedtypes.rst +++ b/docs/source/pyasn1/type/namedtype/namedtypes.rst @@ -6,3 +6,10 @@ NamedTypes .. autoclass:: pyasn1.type.namedtype.NamedTypes :members: + + .. note:: + + The *NamedTypes* objects are normally utilized by the + constructed ASN.1 types (e.g. :ref:`Sequence <univ.Sequence>`, + :ref:`Set <univ.Set>` and :ref:`Choice <univ.Choice>`) to model + the set of fields of those types. diff --git a/docs/source/pyasn1/type/namedtype/optionalnamedtype.rst b/docs/source/pyasn1/type/namedtype/optionalnamedtype.rst index f78bec5..2095b05 100644 --- a/docs/source/pyasn1/type/namedtype/optionalnamedtype.rst +++ b/docs/source/pyasn1/type/namedtype/optionalnamedtype.rst @@ -3,12 +3,18 @@ .. |NamedType| replace:: OptionalNamedType -|NamedType| ------------------- +OptionalNamedType +----------------- .. autoclass:: pyasn1.type.namedtype.OptionalNamedType :members: .. note:: - The |NamedType| class models an optional field of a constructed ASN.1 type. + The *OptionalNamedType* class models an optional field of + a constructed ASN.1 type. + + The *OptionalNamedType* objects are normally utilized by + the :ref:`NamedTypes <namedtype.NamedTypes>` objects + to model individual fields of the constructed ASN.1 + types. |