Update documentation

docs/source/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'ktool'
-copyright = '2021, kat'
+copyright = '2022, kat'
 author = 'cynder'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.0'
+release = '1.2.0'
 
 # -- General configuration ---------------------------------------------------
 

docs/source/ktool.rst

@@ -135,6 +135,10 @@ You should obtain an instance of this class using the public :python:`ktool.load
 
       ExternalDylib object that (admittedly, somewhat confusingly) actually represents this Image itself.
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
    .. py:method:: vm_check(address: int) -> bool
 
       Check if an address resolves within the VM translation table
@@ -244,6 +248,10 @@ ObjCImage
 
       Map of Load addresses to protocols
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
    .. py:method:: vm_check(address: int) -> bool
 
       Check if an address resolves within the VM translation table
@@ -404,6 +412,10 @@ Segment
 
       Size of the segment
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 
 Section
 =================================
@@ -428,6 +440,10 @@ Section
 
       Size of the Section
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 
 Header
 =================================
@@ -528,6 +544,10 @@ ImageHeader
 
       List of load command structs
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 
 ExternalDylib
 =================================
@@ -689,6 +709,10 @@ Class
 
    .. py:attribute:: ivars: List[Ivar]
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 
 Method
 =================================
@@ -726,6 +750,10 @@ Method
 
       Fully built method signature
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 Property
 =================================
 
@@ -749,7 +777,11 @@ Property
 
    .. py:attribute:: ivarname 
 
-      Name of the ivar backing this property 
+      Name of the ivar backing this property
+
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
 
 Ivar
 =================================
@@ -770,6 +802,10 @@ Ivar
 
       Renderable type
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 Category 
 =================================
 
@@ -801,6 +837,10 @@ Category
 
    .. py:attribute:: protocols: List[Protocol]
 
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
+
 
 Protocol 
 =================================
@@ -833,7 +873,11 @@ Protocol
 
       Methods that may (but are not required to) be implemented by classes conforming to this protocol
 
-   .. py:attribute:: properties: List[Property] 
+   .. py:attribute:: properties: List[Property]
+
+   .. py:method:: serialize() -> dict
+
+      Return image metadata as a dictionary of json-serializable keys and objects
 
 
 Type Processing / Encoding