]> git.ipfire.org Git - thirdparty/gettext.git/commitdiff
doc: Update po_message_t API (I)
authorMiguel Ángel Arruga Vivas <rosen644835@gmail.com>
Mon, 6 May 2019 14:05:40 +0000 (16:05 +0200)
committerBruno Haible <bruno@clisp.org>
Sun, 26 Jul 2020 16:36:34 +0000 (18:36 +0200)
* gettext-tools/doc/gettext.texi (po_message_t API): Add
po_message_create documentation.

gettext-tools/doc/gettext.texi

index d73b95304b14697adebcbdde1fd24a77c038823f..6fc7adcc11fe7904a94a6409d141670959f4efbd 100644 (file)
@@ -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.