Bromeon

Welcome

Welcome to the documentation of the Thor Library. Here you'll find a reference for all types, functions, variables and macros of the public API.

If you are new to the library, you might want to go through the tutorials and the code examples first. The documentation is the best choice to lookup specific functionality, however you can also use it to get an overview. In this case, I suggest to take especially a look at the Modules section, there you'll see an summary of each module. The other sections are helpful to inform yourself about a specific class, function or namespace, but you're not going to see much of the context in which it is used.

All functions, constants, namespaces, classes and other types which are part of the public API are located inside the namespace thor (or one of the few nested namespaces). Everything inside namespace detail and all files in the Thor/Detail include directory exist only for internal implementation. Don't use them. In case you come across something useful there, please let me know, so that I can think about an integration to the API. Also don't hesitate to inform me about semantic or formal mistakes you spot in the documentation, the tutorials or the examples.