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

doc: Add format type API

* gettext-tools/doc/gettext.texi (Format Type API): New subsection.
Add po_format_list and po_format_pretty_name documentation.
---

diff --git a/gettext-tools/doc/gettext.texi b/gettext-tools/doc/gettext.texi
index 5b3bbd012..2fe3e66e4 100644
--- a/gettext-tools/doc/gettext.texi
+++ b/gettext-tools/doc/gettext.texi
@@ -5338,6 +5338,7 @@ defined in a library called @samp{libgettextpo}.
 * 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
+* Format Type API::             Supported format types
 @end menu
 
 The following example shows code how these functions can be used.  Error
@@ -5748,6 +5749,19 @@ value @code{(size_t)(-1)} for @var{start_line} denotes that the line
 number is not available.
 @end deftypefun
 
+@node Format Type API
+@subsection Format Type API
+
+@deftypefun {const char * const *} po_format_list (void)
+Return a @code{NULL} terminated array of the supported format types.
+@end deftypefun
+
+@deftypefun {const char *} po_format_pretty_name (const char *@var{format_type})
+Return the pretty name associated with @var{format_type}.  For example,
+it returns ``C#'' when @var{format_type} is ``csharp_format''.
+Return @code{NULL} if @var{format_type} is not a supported format type.
+@end deftypefun
+
 @node Binaries
 @chapter Producing Binary MO Files