Add API doc (just include liblognorm.h)

VultureProject · Dec 25, 2013 · b6edb8f · b6edb8f
1 parent b260ec3
commit b6edb8f
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 10 deletions.
diff --git a/doc/contacts.rst b/doc/contacts.rst
@@ -1,13 +1,13 @@
-Contacts
-========
+Contacts
+========
 
 Mailing list
 ------------
-
-If you have any questions about the library, you may mail to the project
-mailing list [email protected].
-
-To subscribe: http://lists.adiscon.net/mailman/listinfo/lognorm
+
+If you have any questions about the library, you may mail to the project
+mailing list [email protected].
+
+To subscribe: http://lists.adiscon.net/mailman/listinfo/lognorm
 
 Web site
 --------
@@ -24,5 +24,5 @@ Authors
 -------
 
 Rainer Gerhards <[email protected]>, Adiscon GmbH
-
-	His blog: http://blog.gerhards.net/
+
+	His blog: http://blog.gerhards.net/
diff --git a/doc/index.rst b/doc/index.rst
@@ -22,6 +22,7 @@ Contents:
     configuration
     sample_rulebase
     lognormalizer
+    libraryapi
     internals
     license
     contacts

diff --git a/doc/libraryapi.rst b/doc/libraryapi.rst
@@ -0,0 +1,10 @@
+Library API
+===========
+
+To use the library, include liblognorm.h (which is quoted below) into your code.
+The API is fairly simple and hardly needs further explanations.
+
+.. literalinclude:: ../src/liblognorm.h
+	:start-after: #define LIBLOGNORM_H_INCLUDED
+	:end-before: #endif
+	:language: c
diff --git a/src/liblognorm.h b/src/liblognorm.h
@@ -59,7 +59,7 @@
  * A copy of the LGPL v2.1 can be found in the file "COPYING" in this distribution.
  */
 #ifndef LIBLOGNORM_H_INCLUDED
-#define	LIBLOGNORM_H_INCLUDED
+#define LIBLOGNORM_H_INCLUDED
 #include <stdlib.h>	/* we need size_t */
 #include <json.h>
 #include <libestr.h>