Skip to content

Commit

Permalink
Small improvements to docs.
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 f92d648 commit 247c598
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions docs/concepts/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,8 @@ But if you called `m_mod_ref()`, then you own a reference on that module and it'

Moreover, libmodule allows users to override default memhook used, by calling `m_set_memhook()`.
This function must be called from `m_pre_start()` function, because it has to be called before any internal ctor is run, ie: before any allocation takes place.
A memhook is just a wrapper around 3 main memory related functions:

* `malloc`
* `calloc`
* `free`
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 Libmodule Documentation
# Home for 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
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: Libmodule Documentation
site_description: C simple and elegant implementation of an Actor library
site_author: Federico Di Pierro
repo_url: https://github.com/FededDP/libmodule/
repo_url: https://github.com/FedeDP/libmodule/

nav:
- Home: index.md
Expand Down

0 comments on commit 247c598

Please sign in to comment.