summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDov Grobgeld <dov.grobgeld@gmail.com>2017-11-21 14:28:14 +0100
committerGitHub <noreply@github.com>2017-11-21 14:28:14 +0100
commited5f9acf2fb8111432ba99c62c324b3a4166331e (patch)
tree1aa2e2d4b7960aa77e2f59402a48950ac70e3ef8
parentf04ef2d0ecbc4c432534dc49370cd08a34bb800e (diff)
parenta50d5ff754e0ea8808e80af43e9da0043521c274 (diff)
downloadfribidi-ed5f9acf2fb8111432ba99c62c324b3a4166331e.tar.gz
Merge pull request #34 from khaledhosny/docs
Doc fixes
-rw-r--r--lib/fribidi-brackets.h21
-rw-r--r--lib/fribidi-types.h2
2 files changed, 13 insertions, 10 deletions
diff --git a/lib/fribidi-brackets.h b/lib/fribidi-brackets.h
index f2932fe..f557eef 100644
--- a/lib/fribidi-brackets.h
+++ b/lib/fribidi-brackets.h
@@ -43,8 +43,8 @@
#include "fribidi-begindecls.h"
-#define fribidi_get_bracket_char FRIBIDI_NAMESPACE(get_bracket_char)
-/* fribidi_get_bracket_char - get bracketed character
+#define fribidi_get_bracket FRIBIDI_NAMESPACE(get_bracket)
+/* fribidi_get_bracket - get bracketed character
*
* This function finds the bracketed equivalent of a character as defined in
* the file BidiBrackets.txt of the Unicode Character Database available at
@@ -63,14 +63,19 @@ FRIBIDI_ENTRY FriBidiBracketType fribidi_get_bracket (
FriBidiChar ch /* input character */
);
+#define fribidi_get_brackets FRIBIDI_NAMESPACE(get_brackets)
+/* fribidi_get_brackets - get bracketed characters
+ *
+ * This function finds the bracketed characters of an string of characters.
+ * See fribidi_get_bracket() for more information about the bracketed
+ * characters returned by this function.
+ */
FRIBIDI_ENTRY void
fribidi_get_bracket_types (
- /* input */
- const FriBidiChar *str,
- const FriBidiStrIndex len,
- const FriBidiCharType *types,
- /* output */
- FriBidiBracketType *btypes
+ const FriBidiChar *str, /* input string */
+ const FriBidiStrIndex len, /* input string length */
+ const FriBidiCharType *types, /* input bidi types */
+ FriBidiBracketType *btypes /* output bracketed characters */
);
#define FRIBIDI_BRACKET_OPEN_MASK 0x80000000
diff --git a/lib/fribidi-types.h b/lib/fribidi-types.h
index de144c4..ec1e299 100644
--- a/lib/fribidi-types.h
+++ b/lib/fribidi-types.h
@@ -42,7 +42,6 @@
#include "fribidi-begindecls.h"
-#ifndef __FRIBIDI_DOC
# if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || \
defined (_sgi) || defined (__sun) || defined (sun) || \
defined (__digital__) || defined (__HP_cc)
@@ -52,7 +51,6 @@
# else
# include <stdint.h>
# endif
-#endif
typedef int fribidi_boolean;