Files
libloot/docs/api/reference.rst
T
Oliver Hamlet e5a229e09f Move file versioning functions out of DatabaseInterface
They don't need to be member functions, and needing a pointer to an
instance of that interface is awkward.

The function names have also changed to reflect that they're not
specific to the masterlists.
2021-09-23 13:31:34 +01:00

120 lines
1.9 KiB
ReStructuredText

*************
API Reference
*************
.. contents::
Enumerations
============
.. doxygenenum:: loot::EdgeType
.. doxygenenum:: loot::GameType
.. doxygenenum:: loot::LogLevel
.. doxygenenum:: loot::MessageType
Public-Field Data Structures
============================
.. doxygenstruct:: loot::FileRevision
:members:
.. doxygenstruct:: loot::SimpleMessage
:members:
Functions
=========
.. doxygenfunction:: loot::SetLoggingCallback
.. doxygenfunction:: loot::IsCompatible
.. doxygenfunction:: loot::CreateGameHandle
.. doxygenfunction:: loot::UpdateFile
.. doxygenfunction:: loot::GetFileRevision
.. doxygenfunction:: loot::IsLatestFile
Interfaces
==========
.. doxygenclass:: loot::DatabaseInterface
:members:
.. doxygenclass:: loot::GameInterface
:members:
.. doxygenclass:: loot::PluginInterface
:members:
Classes
=======
.. doxygenclass:: loot::ConditionalMetadata
:members:
.. doxygenclass:: loot::Filename
:members:
.. doxygenclass:: loot::File
:members:
.. doxygenclass:: loot::Group
:members:
.. doxygenclass:: loot::Location
:members:
.. doxygenclass:: loot::LootVersion
:members:
.. doxygenclass:: loot::MessageContent
:members:
.. doxygenclass:: loot::Message
:members:
.. doxygenclass:: loot::PluginCleaningData
:members:
.. doxygenclass:: loot::PluginMetadata
:members:
.. doxygenclass:: loot::Tag
:members:
.. doxygenclass:: loot::Vertex
:members:
Exceptions
==========
.. doxygenclass:: loot::CyclicInteractionError
:members:
.. doxygenclass:: loot::GitStateError
:members:
.. doxygenclass:: loot::ConditionSyntaxError
:members:
.. doxygenclass:: loot::FileAccessError
:members:
.. doxygenclass:: loot::UndefinedGroupError
:members:
Error Categories
================
LOOT uses error category objects to identify errors with codes that originate in
lower-level libraries.
.. doxygenfunction:: loot::libloadorder_category
.. doxygenfunction:: loot::libgit2_category