*** empty log message ***

[m17n/m17n-lib.git] / src / mtext-lbrk.c

diff --git a/src/mtext-lbrk.c b/src/mtext-lbrk.c
index 82b81c0..e61efd3 100644 (file)
--- a/src/mtext-lbrk.c
+++ b/src/mtext-lbrk.c
@@ -1,5 +1,5 @@
 /* mtext-lbrk.c -- line break
-   Copyright (C) 2005
+   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010
      National Institute of Advanced Industrial Science and Technology (AIST)
      Registration Number H15PRO112
 
@@ -17,7 +17,7 @@
 
    You should have received a copy of the GNU Lesser General Public
    License along with the m17n library; if not, write to the Free
-   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    02111-1307, USA.  */
 
 #if !defined (FOR_DOXYGEN) || defined (DOXYGEN_INTERNAL_MODULE)
@@ -163,6 +163,21 @@ static MCharTable *lbc_table;
 /*** @{ */
 /*=*/
 
+/***en
+    @brief Find a linebreak postion of an M-text.
+
+    The mtext_line_break () function checks if position $POS is a
+    proper linebreak position of an M-text $MT according to the
+    algorithm of The Unicode Standard 4.0 UAX#14.  It so, it returns
+    $POS.  Otherwise, it returns a proper linebreak position before
+    $POS.
+
+    If $OPTION is nonzero, it controls the algorithm by logical-or of
+    the members of #MTextLineBreakOption.
+
+    If $AFTER is not NULL, a proper linebreak position after $POS is
+    stored there.  */
+
 int
 mtext_line_break (MText *mt, int pos, int option, int *after)
 {