view doc/docs/dev/api/core/core.md @ 253:c4da052c0def

core: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Thu, 03 Dec 2020 09:06:52 +0100
parents
children 196264679079
line wrap: on
line source

# Module: core

Synopsis

```c
#include <core/core.h>
```

Main entry point for the libmlk-core library.

The library must be initialized before attempting to call any other functions in
the API.

## Functions

### core\_init

Initialize the library.

You must specify an `organization` and program `name`. The `organization`
argument can be anything but [reversed domain name notation][rdnn] is often
used. It will also determine the path to the preferred directories on certain
platforms so make sure to not use characters that may be illegal on some
filesystems.

Returns false in case of errors.

```c
bool
core_init(const char *organization, const char *name)
```

### core\_finish

Close the library.

```c
void
core_finish(void)
```

[rdnn]: https://en.wikipedia.org/wiki/Reverse_domain_name_notation