Updated doc

FedeDP · Mar 10, 2018 · f1488fd · f1488fd
1 parent 67397e1
commit f1488fd
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 30 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,11 +10,12 @@ Welcome to libmodule's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   src/concepts
    src/data_structures
-   src/module_callbacks
+   src/callbacks
    src/module
    src/modules
-   src/module_context
+   src/context
 
 Indices and tables
 ==================

diff --git a/docs/src/module_callbacks.rst → docs/src/callbacks.rst b/docs/src/module_callbacks.rst → docs/src/callbacks.rst
@@ -5,7 +5,7 @@
 Module callbacks
 ================
 
-Every module needs 5 callbacks that must defined by developer. |br|
+Every module needs 5 callbacks that be must defined by developer. |br|
 They are automatically declared by MODULE macro:
 
 .. code::

diff --git a/docs/src/concepts.rst b/docs/src/concepts.rst
@@ -0,0 +1,31 @@
+.. |br| raw:: html
+
+   <br />
+
+Libmodule Concepts
+==================
+
+Module concept
+--------------
+
+A module is key entity of libmodule: it is a single and indipendent logical unit that reacts to certain events by polling on a fd. |br|
+It offers some callbacks that are used by libmodule to manage its life. |br|
+It is initialized through MODULE macro:
+
+.. code::
+    
+    MODULE(test)
+    
+This macro creates a "test" module. |br|
+MODULE macro also creates a constructor and destructor that are automatically called by libmodule at start and at end of program. |br|
+Finally, this macro declares all of needed callbacks and returns an opaque handler for the module, that will be transparently passed with each call to libmodule API while using easy AP:ref:`module_easy`. |br|
+
+Submodule concept
+-----------------
+
+PLACEHOLDER
+
+Context concept
+---------------
+
+PLACEHOLDER
diff --git a/docs/src/context.rst b/docs/src/context.rst
@@ -0,0 +1,10 @@
+.. |br| raw:: html
+
+   <br />
+
+Libmodule Context-aware API
+===========================
+
+PLACEHOLDER
+
+
diff --git a/docs/src/data_structures.rst b/docs/src/data_structures.rst
@@ -9,8 +9,8 @@ Libmodule Data Structures
     /* Message received in poll callback */
     typedef struct {
         int fd;
-        const char *message; // field unused for now
-        const char *sender; // field unused for now
+        const char *message;                    // field unused for now
+        const char *sender;                     // field unused for now
     } message_t;
 
     /* Callbacks typedefs */

diff --git a/docs/src/module.rst b/docs/src/module.rst
@@ -5,21 +5,6 @@
 Module
 ======
 
-Module concept
---------------
-
-A module is key entity of libmodule: it is a single and indipendent logical unit that reacts to certain events by polling on a fd. |br|
-It offers some callbacks that are used by libmodule to manage its life. |br|
-It is initialized through MODULE macro:
-
-.. code::
-    
-    MODULE(test)
-    
-This macro creates a "test" module. |br|
-MODULE macro also creates a constructor and destructor that are automatically called by libmodule at start and at end of program. |br|
-Finally, this macro also declares all of needed callbacks and returns an opaque handler for the module, that will be transparently passed with each call to libmodule API while using easy API.
-
 .. _module_easy:    
 
 Module easy API

diff --git a/docs/src/module_context.rst b/docs/src/module_context.rst