From: Miguel Ángel Arruga Vivas <rosen644835@gmail.com>
Date: Mon, 6 May 2019 15:00:38 +0000 (+0200)
Subject: doc: Update po_message_t API (IV)
X-Git-Tag: v0.21~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=60ffce284b2cf74a15866744f7037fe01c5b06dc;p=thirdparty%2Fgettext.git

doc: Update po_message_t API (IV)

* gettext-tools/doc/gettext.texi (po_message_t API): Add
po_message_is_obsolete, po_message_set_obsolete, po_message_is_fuzzy,
po_message_set_fuzzy, po_message_is_format, po_message_set_format,
po_message_is_range, and po_message_set_range documentation.
---

diff --git a/gettext-tools/doc/gettext.texi b/gettext-tools/doc/gettext.texi
index e70a8f4e6..6e6f2f9a2 100644
--- a/gettext-tools/doc/gettext.texi
+++ b/gettext-tools/doc/gettext.texi
@@ -5636,6 +5636,55 @@ comments of a message to the value @var{extracted_comments}, a multiline
 string, ending in a newline, or a non-@code{NULL} empty string.
 @end deftypefun
 
+@deftypefun {int} po_message_is_obsolete (po_message_t @var{message})
+The @code{po_message_is_obsolete} function returns true when the message
+is marked as obsolete.
+@end deftypefun
+
+@deftypefun {void} po_message_set_obsolete (po_message_t @var{message},@
+                   int @var{obsolete})
+The @code{po_message_set_obsolete} function changes the obsolete mark of
+the message.
+@end deftypefun
+
+@deftypefun {int} po_message_is_fuzzy (po_message_t @var{message})
+The @code{po_message_is_fuzzy} function returns true when the message
+is marked as fuzzy.
+@end deftypefun
+
+@deftypefun {void} po_message_set_fuzzy (po_message_t @var{message},@
+                   int @var{fuzzy})
+The @code{po_message_set_fuzzy} function changes the fuzzy mark of
+the message.
+@end deftypefun
+
+@deftypefun {int} po_message_is_format (po_message_t @var{message},@
+                  const char *@var{format_type})
+The @code{po_message_is_format} function returns true when the message
+is marked as being a format string of @var{format_type}.
+@end deftypefun
+
+@deftypefun {void} po_message_set_format (po_message_t @var{message},@
+                   const char *@var{format_type}, int @var{value})
+The @code{po_message_set_fuzzy} function changes the format mark of
+the message for the @var{format_type} provided.
+@end deftypefun
+
+@deftypefun {int} po_message_is_range (po_message_t @var{message},@
+                  int *@var{minp}, int *@var{maxp})
+The @code{po_message_is_range} function returns true when the message
+has a numeric range set, and stores the minimum and maximum value in the
+direction pointed by @var{minp} and @var{maxp} respectively.
+@end deftypefun
+
+@deftypefun {void} po_message_set_range (po_message_t @var{message},@
+                   int @var{min}, int @var{max})
+The @code{po_message_set_range} function changes the numeric range of
+the message. @var{min} and @var{max} must be non-negative, with
+@var{min} < @var{max}.  Use @var{min} and @var{max} with value @code{-1}
+to remove the numeric range of @var{message}
+@end deftypefun
+
 @node PO Header Entry API
 @subsection PO Header Entry API