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

doc: Update po_message_t API (II)

* gettext-tools/doc/gettext.texi (po_message_t API): Add
po_message_msgctxt, po_message_comments, and
po_message_extracted_comments documentation.
---

diff --git a/gettext-tools/doc/gettext.texi b/gettext-tools/doc/gettext.texi
index 6fc7adcc1..95f69b45d 100644
--- a/gettext-tools/doc/gettext.texi
+++ b/gettext-tools/doc/gettext.texi
@@ -5542,6 +5542,12 @@ available to the user of the library.
 The following functions returns details of a @code{po_message_t}.  Recall
 that the results are valid as long as the @var{file} handle is valid.
 
+@deftypefun {const char *} po_message_msgctxt (po_message_t @var{message})
+The @code{po_message_msgctxt} function returns the @code{msgctxt}, the
+context of the message.  Return @code{NULL} for a message not restricted
+to a context.
+@end deftypefun
+
 @deftypefun {const char *} po_message_msgid (po_message_t @var{message})
 The @code{po_message_msgid} function returns the @code{msgid} (untranslated
 English string) of a message.  This is guaranteed to be non-@code{NULL}.
@@ -5565,6 +5571,16 @@ The @code{po_message_msgstr_plural} function returns the
 the @var{index} is out of range or for a message without plural.
 @end deftypefun
 
+@deftypefun {const char *} po_message_comments (po_message_t @var{message})
+The @code{po_message_comments} function returns the comments of a message,
+a multiline string, ending in a newline, or a non-@code{NULL} empty string.
+@end deftypefun
+
+@deftypefun {const char *} po_message_extracted_comments (po_message_t @var{message})
+The @code{po_message_extracted_comments} function returns the extracted comments of a message,
+a multiline string, ending in a newline, or a non-@code{NULL} empty string.
+@end deftypefun
+
 @node Binaries
 @chapter Producing Binary MO Files