Skip to content

Commit

Permalink
Small improvements to doc.
Browse files Browse the repository at this point in the history
Signed-off-by: Federico Di Pierro <nierro92@gmail.com>
  • Loading branch information
FedeDP committed Feb 4, 2022
1 parent a8bb069 commit f92d648
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
20 changes: 11 additions & 9 deletions docs/concepts/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,21 @@
## Naming Conventions

Libmodule uses the following naming conventions:
* `m_` is the prefix for all the library API
* `m_foo_` APIs group together the same namespace API
* struct types have the `_t` suffix
* enum types **do not have** the `_t` suffix

* `m_` is the prefix for all the library API
* `m_foo_` APIs group together the same namespace API
* struct types have the `_t` suffix
* enum types **do not have** the `_t` suffix

## Logging

Libmodule offers an internal logging facility, to enable verbose logging for the library.
There are 4 log levels that can be enabled through `LIBMODULE_LOG` env variable:
* 0 (error, **default**)
* 1 (warn)
* 2 (info)
* 3 (debug)
There are 4 log levels that can be enabled through `LIBMODULE_LOG` env variable:

* 0 (error, **default**)
* 1 (warn)
* 2 (info)
* 3 (debug)

Moreover, you can specify an output file for the log, by passing `LIBMODULE_LOG_OUTPUT` env variable.
By default, stdout is used.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to Libodule Documentation
# Welcome to Libmodule Documentation

Libmodule offers a small and simple C implementation of an actor library that aims to let developers easily create modular C projects in a way which is both simple and elegant.

Expand Down
37 changes: 19 additions & 18 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,25 @@ site_author: Federico Di Pierro
repo_url: https://github.com/FededDP/libmodule/

nav:
- 'Home': 'index.md'
- 'Concepts':
- 'concepts/concepts.md'
- 'Module': 'concepts/mod.md'
- 'Context': 'concepts/ctx.md'
- 'Core API':
- 'core/core.md'
- 'Module API': 'core/mod.md'
- 'Context API': 'core/ctx.md'
- 'Data Structures API':
- 'structs/structs.md'
- 'Map': 'structs/map.md'
- 'List': 'structs/list.md'
- 'Queue': 'structs/queue.md'
- 'Stack': 'structs/stack.md'
- 'Bst': 'structs/bst.md'
- 'Reference counted memory': 'mem/mem.md'
- 'Thread Pool API': 'thpool/thpool.md'
- Home: index.md
- Concepts:
- concepts/concepts.md
- Module: concepts/mod.md
- Context: concepts/ctx.md
- Core API:
- core/core.md
- Module API: core/mod.md
- Context API: core/ctx.md
- Data Structures API:
- structs/structs.md
- Map: structs/map.md
- List: structs/list.md
- Queue: structs/queue.md
- Stack: structs/stack.md
- Bst: structs/bst.md
- Reference counted memory: mem/mem.md
- Thread Pool API: thpool/thpool.md

theme: readthedocs

markdown_extensions:
Expand Down

0 comments on commit f92d648

Please sign in to comment.