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

doc: Update po_message_t API (I)

* gettext-tools/doc/gettext.texi (po_message_t API): Add
po_message_create documentation.
---

diff --git a/gettext-tools/doc/gettext.texi b/gettext-tools/doc/gettext.texi
index d73b95304..6fc7adcc1 100644
--- a/gettext-tools/doc/gettext.texi
+++ b/gettext-tools/doc/gettext.texi
@@ -5532,6 +5532,13 @@ This is a pointer type that refers to a message of a PO file, including its
 translation.
 @end deftp
 
+@deftypefun {po_message_t} po_message_create (void)
+Return a freshly constructed message.  To finish initializing the
+message, you must set the msgid and msgstr.  It @emph{must} be inserted
+into a file to manage its memory, as there is no @code{po_message_free}
+available to the user of the library.
+@end deftypefun
+
 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.