diff options
author | Ilya Etingof <etingof@gmail.com> | 2017-11-14 11:12:09 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-11-14 11:12:09 +0100 |
commit | c34f53e7ee787577482f9e1b67ea507299dd3be3 (patch) | |
tree | 1aa1420059f55f824ed4a6ea812386be426ed63f /docs/source/pyasn1/type | |
parent | dc865c255eed64d222cab8bcb9d15e08cc74e2c9 (diff) | |
download | pyasn1-c34f53e7ee787577482f9e1b67ea507299dd3be3.tar.gz |
added example code snippets to the docstrings (#101)
Diffstat (limited to 'docs/source/pyasn1/type')
-rw-r--r-- | docs/source/pyasn1/type/namedtype/defaultednamedtype.rst | 10 | ||||
-rw-r--r-- | docs/source/pyasn1/type/namedtype/namedtype.rst | 12 | ||||
-rw-r--r-- | docs/source/pyasn1/type/namedtype/namedtypes.rst | 7 | ||||
-rw-r--r-- | docs/source/pyasn1/type/namedtype/optionalnamedtype.rst | 12 | ||||
-rw-r--r-- | docs/source/pyasn1/type/tag/tag.rst | 10 | ||||
-rw-r--r-- | docs/source/pyasn1/type/tag/tagmap.rst | 6 | ||||
-rw-r--r-- | docs/source/pyasn1/type/tag/tagset.rst | 6 |
7 files changed, 54 insertions, 9 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. diff --git a/docs/source/pyasn1/type/tag/tag.rst b/docs/source/pyasn1/type/tag/tag.rst index 0536b61..3aeb670 100644 --- a/docs/source/pyasn1/type/tag/tag.rst +++ b/docs/source/pyasn1/type/tag/tag.rst @@ -5,6 +5,14 @@ Solitary tag ------------ .. automodule:: pyasn1.type.tag - :members: Tag, tagClassUniversal, tagClassApplication, tagClassContext, + :members: tagClassUniversal, tagClassApplication, tagClassContext, tagClassPrivate, tagFormatSimple, tagFormatConstructed +.. autoclass:: pyasn1.type.tag.Tag + :members: + + .. note:: + + The *Tag* objects are normally used by the + :ref:`TagSet <tag.TagSet>`, objects to model a collection + of ASN.1 tags. diff --git a/docs/source/pyasn1/type/tag/tagmap.rst b/docs/source/pyasn1/type/tag/tagmap.rst index a3222e3..05b8404 100644 --- a/docs/source/pyasn1/type/tag/tagmap.rst +++ b/docs/source/pyasn1/type/tag/tagmap.rst @@ -6,3 +6,9 @@ Tag->type map .. autoclass:: pyasn1.type.tagmap.TagMap :members: + + .. note:: + + The *TagMap* objects are used by the + :ref:`TagSet <tag.TagSet>`, objects for looking up components + of constructed ASN.1 types by :ref:`Tag <tag.Tag>`. diff --git a/docs/source/pyasn1/type/tag/tagset.rst b/docs/source/pyasn1/type/tag/tagset.rst index 566238a..c4dce2e 100644 --- a/docs/source/pyasn1/type/tag/tagset.rst +++ b/docs/source/pyasn1/type/tag/tagset.rst @@ -6,3 +6,9 @@ Tag set .. autoclass:: pyasn1.type.tag.TagSet :members: + + .. note:: + + The *TagSet* objects are normally used by all ASN.1 type + objects both simple (like :ref:`Integer <univ.Integer>`) + and constructed (e.g. :ref:`Sequence <univ.Sequence>`). |