From: ElOraiby <wael.eloraiby@gmail.com>
Date: Sat, 30 May 2015 20:33:26 +0000 (-0400)
Subject: api doc
X-Git-Url: https://code.bitgloo.com/?a=commitdiff_plain;h=49cbdb57df769e19fa0d75a9b6c1569ef2fe6849;p=clyne%2Farabtype.git

api doc
---

diff --git a/arabtype.h b/arabtype.h
index 16470d9..1e5377c 100644
--- a/arabtype.h
+++ b/arabtype.h
@@ -23,6 +23,13 @@
 extern "C" {
 #endif	// __cplusplus
 
+/**
+ * @brief get_presentation_form_b
+ * @param prev previous character
+ * @param next next character
+ * @param cp the current character
+ * @return 0 ignore the code point, the transformed code point otherise
+ */
 uint32_t get_presentation_form_b(uint32_t prev, uint32_t next, uint32_t cp);
 
 #ifdef __cplusplus