mirror of
https://github.com/loot/libloot-python.git
synced 2026-07-27 14:14:13 -07:00
Oliver Hamlet
01a8567ed8
It's easier to maintain, though there seems to be a bug in pybind11, as it doesn't use the docstrings I've provided for some static read-only properties, so Version and WrapperVersion are still documented separately. It's not related, but I've noticed that for some reason intersphinx is unable to turn :cpp: domain references into hyperlinks, but no related information is logged to say why.
63 lines
1.6 KiB
ReStructuredText
63 lines
1.6 KiB
ReStructuredText
*************
|
|
API Reference
|
|
*************
|
|
|
|
As this API is just a wrapper for libloot's C++ API, its documentation is linked
|
|
to for all non-Python-specific information.
|
|
|
|
The wrapped enumeration types are classes in Python, but the distinction
|
|
makes no difference in practice, so they're grouped here for semantics. All
|
|
their values are unsigned integer constants.
|
|
|
|
.. automodule:: loot
|
|
:members:
|
|
:exclude-members: Version, WrapperVersion
|
|
|
|
.. py:class:: loot.Version
|
|
|
|
Wraps :cpp:class:`loot::LootVersion`.
|
|
|
|
.. py:attribute:: major
|
|
|
|
An unsigned integer giving the major version number.
|
|
|
|
.. py:attribute:: minor
|
|
|
|
An unsigned integer giving the minor version number.
|
|
|
|
.. py:attribute:: patch
|
|
|
|
An unsigned integer giving the patch version number.
|
|
|
|
.. py:attribute:: revision
|
|
|
|
A Unicode string containing the SHA-1 of the Git revision that the wrapped C++ API was built from.
|
|
|
|
.. py:staticmethod:: string() -> str
|
|
|
|
Returns the API version as a string of the form ``major.minor.patch``
|
|
|
|
.. py:class:: loot.WrapperVersion
|
|
|
|
Provides information about the version of libloot-python that is being run.
|
|
|
|
.. py:attribute:: major
|
|
|
|
An unsigned integer giving the major version number.
|
|
|
|
.. py:attribute:: minor
|
|
|
|
An unsigned integer giving the minor version number.
|
|
|
|
.. py:attribute:: patch
|
|
|
|
An unsigned integer giving the patch version number.
|
|
|
|
.. py:attribute:: revision
|
|
|
|
A Unicode string containing the SHA-1 of the Git revision that the wrapped C++ API was built from.
|
|
|
|
.. py:staticmethod:: string() -> str
|
|
|
|
Returns the API version as a string of the form ``major.minor.patch``
|