[gnunet-scheme] 233/324: doc: Document the message type database a little.

[gnunet]

This is an automated email from the git hooks/post-receive script.

maxime-devos pushed a commit to branch master
in repository gnunet-scheme.

commit 643d42dd635d2c8937f92de34bf24b8119e16429
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Fri Sep 3 22:48:10 2021 +0200

    doc: Document the message type database a little.
    
    * doc/scheme-gnunet.tm (Message type database): New section.
---
 doc/scheme-gnunet.tm | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
index 3b60d46..8050718 100644
--- a/doc/scheme-gnunet.tm
+++ b/doc/scheme-gnunet.tm
@@ -392,6 +392,26 @@
 
   <todo|document the message type database, various procedures>
 
+  <subsection|Message type database>
+
+  The module <scm|(gnu gnunet message protocols)> has a mapping of symbolic
+  names of every message type known to scheme-GNUnet to their numeric
+  value.<space|1em>To use it, the macro <scm|symbol-value> from <scm|(gnu
+  extractor enum)> is required and possibly <scm|value-\<gtr\>index> as
+  well.<space|1em>To determine the numeric value of the message type
+  <scm|msg:nse:estimate>, one would write:
+
+  <\scm-code>
+    (define numeric-type
+
+    \ \ (value-\<gtr\>index (symbol-value message-type msg:nse:estimate)))
+  </scm-code>
+
+  <todo|other various enum procedures for introspection, documentation,
+  <text-dots>?>
+
+  <todo|how to define new message types>
+
   <subsection|Error handler>
 
   The message queue implementation usually just sends and receives messages,

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.