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

doc: Add po_filepos_t API

* gettext-tools/doc/gettext.texi (po_filepos_t API): New
subsection. Add po_message_filepos, po_message_remove_filepos, and
po_message_add_filepos documentation.
(libgettextpo): Add new subsection to the menu.
---

diff --git a/gettext-tools/doc/gettext.texi b/gettext-tools/doc/gettext.texi
index 83fe10306..e70a8f4e6 100644
--- a/gettext-tools/doc/gettext.texi
+++ b/gettext-tools/doc/gettext.texi
@@ -5337,6 +5337,7 @@ defined in a library called @samp{libgettextpo}.
 * po_message_iterator_t API::   Message iteration
 * po_message_t API::            The basic units of the file
 * PO Header Entry API::         Meta information of the file
+* po_filepos_t API::            References to the sources
 @end menu
 
 The following example shows code how these functions can be used.  Error
@@ -5664,6 +5665,37 @@ Return a freshly allocated string which contains the entry from
 necessary.
 @end deftypefun
 
+@node po_filepos_t API
+@subsection po_filepos_t API
+
+@deftp {Data Type} po_filepos_t
+This is a pointer type that refers to a string's position within a
+source file.
+@end deftp
+
+The following functions provide an interface to extract and manipulate
+these references.
+
+@deftypefun {po_filepos_t} po_message_filepos (po_message_t @var{message},@
+                           int @var{index})
+Return the file reference in position @var{index} from the message.  If
+@var{index} is out of range, return @code{NULL}.
+@end deftypefun
+
+@deftypefun {void} po_message_remove_filepos (po_message_t @var{message},@
+                   int @var{index})
+Remove the file reference in position @var{index} from the message.  It
+moves all references following @var{index} one position backwards.
+@end deftypefun
+
+@deftypefun {void} po_message_add_filepos (po_message_t @var{message},@
+                   const char *@var{file}, size_t @var{start_line})
+Add a reference to the string from @var{file} starting at
+@var{start_line}, if it is not already present for the message.  The
+value @code{(size_t)(-1)} for @var{start_line} denotes that the line
+number is not available.
+@end deftypefun
+
 @node Binaries
 @chapter Producing Binary MO Files