doc: Update po_file_read documentation

* gettext-tools/doc/gettext.texi (libgettextpo): Update documentation
from po_file_read to the version 3 of the implementation.
* gettext-tools/libgettextpo/gettext-po.in.h (po_file_read): Update
comment.
This commit is contained in:
Miguel Ángel Arruga Vivas
2019-05-05 19:54:44 +02:00
committed by Bruno Haible
parent 4f783e2b3d
commit ceb9bd73aa
2 changed files with 9 additions and 4 deletions
+8 -3
View File
@@ -5402,11 +5402,16 @@ The @code{po_file_create} creates an empty PO file representation in
memory.
@end deftypefun
@deftypefun po_file_t po_file_read (const char *@var{filename})
@deftypefun po_file_t po_file_read (const char *@var{filename},@
struct po_xerror_handler *@var{handler})
The @code{po_file_read} function reads a PO file into memory. The file name
is given as argument. The return value is a handle to the PO file's contents,
valid until @code{po_file_free} is called on it. In case of error, the return
value is @code{NULL}, and @code{errno} is set.
valid until @code{po_file_free} is called on it. In case of error, the
functions from @var{handler} are called to signal it.
This function is exported as @samp{po_file_read_v3} at ABI level, but it
defined as @code{po_file_read} in C code after the inclusion of
@samp{<gettext-po.h>}.
@end deftypefun
@deftypefun void po_file_free (po_file_t @var{file})
+1 -1
View File
@@ -131,7 +131,7 @@ typedef const struct po_xerror_handler *po_xerror_handler_t;
extern po_file_t po_file_create (void);
/* Read a PO file into memory.
Return its contents. Upon failure, return NULL and set errno. */
Return its contents. Upon failure, call function from handler. */
#define po_file_read po_file_read_v3
extern po_file_t po_file_read (const char *filename,
po_xerror_handler_t handler);