X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=include%2Fmarkdown.h;h=655d8f34d0670d905c3e96962538bccf3659d0ad;hb=b416f18295f7edcb5474396a6b26a59fd5ddb1f5;hp=62d147130295b03d52378a242d74f0763405f516;hpb=0f870f29388a36d32ec9ffaabe9ffe03edc038c0;p=smdp.git

diff --git a/include/markdown.h b/include/markdown.h
index 62d1471..655d8f3 100644
--- a/include/markdown.h
+++ b/include/markdown.h
@@ -4,6 +4,18 @@
 /*
  * A implementation of markdown objects.
  *
+ * enum: line_bitmask which enumerates markdown formating bits
+ *
+ * struct: deck_t the root object representing a deck of slides
+ * struct: slide_t a linked list element of type slide contained in a deck
+ * struct: line_t a linked list element of type line contained in a slide
+ *
+ * function: new_deck to initialize a new deck
+ * function: new_slide to initialize a new linked list of type slide
+ * function: next_slide to extend a linked list of type slide by one element
+ * function: new_line to initialize a new linked list of type line
+ * function: next_line to extend a linked list of type line by one element
+ *
  */
 
 #include "cstring.h"