From 8a732fb71b40b8c33b1362e9025c63373ccdb040 Mon Sep 17 00:00:00 2001
From: William Roberts <william.c.roberts@intel.com>
Date: Tue, 30 Nov 2021 14:25:35 -0600
Subject: [PATCH] docs: start types documentation

Signed-off-by: William Roberts <william.c.roberts@intel.com>
---
 docs/index.rst      |  1 +
 docs/types.rst      |  6 ++++++
 tpm2_pytss/types.py | 28 ++++++++++++++++++++++++++++
 3 files changed, 35 insertions(+)
 create mode 100644 docs/types.rst

diff --git a/docs/index.rst b/docs/index.rst
index 4b285201..38e7dd68 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -148,6 +148,7 @@ to change.
     :maxdepth: 2
     :caption: Contents:
 
+    types
     esys
     fapi
     utils
diff --git a/docs/types.rst b/docs/types.rst
new file mode 100644
index 00000000..5762a8f9
--- /dev/null
+++ b/docs/types.rst
@@ -0,0 +1,6 @@
+Types
+=====
+
+.. automodule:: tpm2_pytss.types
+   :members:
+   :undoc-members:
diff --git a/tpm2_pytss/types.py b/tpm2_pytss/types.py
index f65abcee..55739728 100644
--- a/tpm2_pytss/types.py
+++ b/tpm2_pytss/types.py
@@ -1,5 +1,12 @@
 # SPDX-License-Identifier: BSD-2
+"""
+The types module contains types for each of the corresponding TPM types from the TCG TSS specification
+- https://trustedcomputinggroup.org/resource/tss-overview-common-structures-specification
 
+The classes contained within can be initialized based on named argument value pairs or dictionaries
+of key-value objects where the keys are the names of the associated type.
+
+"""
 from ._libtpm2_pytss import ffi, lib
 
 from tpm2_pytss.internal.utils import (
@@ -40,14 +47,20 @@
 
 
 class ParserAttributeError(Exception):
+    """ Exception ocurred when when parsing."""
+
     pass
 
 
 class TPM2_HANDLE(int):
+    """"A handle to a TPM address"""
+
     pass
 
 
 class TPM_OBJECT(object):
+    """ Abstract Base class for all TPM Objects. Not suitable for direct instantiation."""
+
     def __init__(self, _cdata=None, **kwargs):
 
         # Rather than trying to mock the FFI interface, just avoid it and return
@@ -197,6 +210,9 @@ def unmarshal(cls, buf):
 
 
 class TPM2B_SIMPLE_OBJECT(TPM_OBJECT):
+    """ Abstract Base class for all TPM2B Simple Objects. A Simple object contains only
+    a size and byte buffer fields. This is not suitable for direct instantiation."""
+
     def __init__(self, _cdata=None, **kwargs):
 
         _cdata, kwargs = _fixup_cdata_kwargs(self, _cdata, kwargs)
@@ -274,6 +290,15 @@ def __eq__(self, value):
 
 
 class TPML_Iterator(object):
+    """ Iterator class for iterating over TPML data types.
+
+    This class is used in enumerated for loops, such as:
+    .. code-block:: python
+
+    for alg in TPML_ALG:
+       do_something(alg)
+    """
+
     def __init__(self, tpml):
         self._tpml = tpml
         self._index = 0
@@ -292,6 +317,9 @@ def __next__(self):
 
 
 class TPML_OBJECT(TPM_OBJECT):
+    """ Abstract Base class for all TPML Objects. A TPML object is an object that
+    contains a list of objects. This is not suitable for direct instantiation."""
+
     def __init__(self, _cdata=None, **kwargs):
 
         _cdata, kwargs = _fixup_cdata_kwargs(self, _cdata, kwargs)