.. zydis documentation master file, created by
   sphinx-quickstart on Tue Jun 25 16:47:21 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the zydis-py doc!
============================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. automodule:: zydis

Convenience
-----------

.. autofunction:: decode_and_format_all

Decoding
--------

.. autoclass:: Decoder
   :members:
   :undoc-members:

.. autoclass:: DecodedInstruction
   :members:
   :undoc-members:

.. autoclass:: DecodedInstructionRaw
   :members:
   :undoc-members:

.. autoclass:: Operand
   :members:
   :undoc-members:

.. autoclass:: ImmOperand
   :members:
   :undoc-members:

.. autoclass:: PtrOperand
   :members:
   :undoc-members:

.. autoclass:: MemOperand
   :members:
   :undoc-members:

.. autoclass:: RegOperand
   :members:
   :undoc-members:

Formatting
----------

.. autoclass:: Formatter
   :members:
   :undoc-members:

Misc
----

.. autoclass:: StatusCode
   :members:
   :undoc-members:

.. autoclass:: Version
   :members:
   :undoc-members:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`