pidgin/pidgin

Fix a couple GI/doc warnings

2020-10-07, Elliott Sales de Andrade
42fd60e3fbe8
Parents 8079731c8ef9
Children a144fe8ec06f
Fix a couple GI/doc warnings

* De-publicize glibcompat.h
It's not meant for external users.

* Fix docs of `_purple_network_set_common_socket_flags`.
It seems to still be Doxygen-styled.

Testing Done:
Compile.

Reviewed at https://reviews.imfreedom.org/r/146/
4 files changed, 7 insertions(+), 6 deletions(-)
  • +1 -0
    doc/reference/libpurple/meson.build
  • +1 -0
    libpurple/glibcompat.h
  • +0 -1
    libpurple/meson.build
  • +5 -5
    libpurple/network.h
    • --- a/doc/reference/libpurple/meson.build Tue Oct 06 20:44:33 2020 -0500
    +++ b/doc/reference/libpurple/meson.build Wed Oct 07 01:10:20 2020 -0500
    @@ -8,6 +8,7 @@
    'tests',
    'win32',
    'backend-fs2.h',
    + 'glibcompat.h',
    'internal.h',
    'purpleprivate.h',
    ]
    --- a/libpurple/glibcompat.h Tue Oct 06 20:44:33 2020 -0500
    +++ b/libpurple/glibcompat.h Wed Oct 07 01:10:20 2020 -0500
    @@ -55,6 +55,7 @@
    #if !GLIB_CHECK_VERSION(2, 62, 0)
    #define g_date_time_format_iso8601(dt) (purple_compat_date_time_format_iso8601((dt)))
    +G_GNUC_INTERNAL
    gchar *purple_compat_date_time_format_iso8601(GDateTime *datetime);
    #endif /* GLIB_CHECK_VERSION(2, 62, 0) */
    --- a/libpurple/meson.build Tue Oct 06 20:44:33 2020 -0500
    +++ b/libpurple/meson.build Wed Oct 07 01:10:20 2020 -0500
    @@ -108,7 +108,6 @@
    'countingnode.h',
    'debug.h',
    'eventloop.h',
    - 'glibcompat.h',
    'group.h',
    'idle.h',
    'image.h',
    --- a/libpurple/network.h Tue Oct 06 20:44:33 2020 -0500
    +++ b/libpurple/network.h Wed Oct 07 01:10:20 2020 -0500
    @@ -328,14 +328,14 @@
    void purple_network_remove_port_mapping(gint fd);
    /**
    + * _purple_network_set_common_socket_flags:
    + * @fd: The file descriptor for the socket.
    + *
    * Sets most commonly used socket flags: O_NONBLOCK and FD_CLOEXEC.
    *
    - * @param fd The file descriptor for the socket.
    - *
    - * @return TRUE if succeeded, FALSE otherwise.
    + * Returns: %TRUE if succeeded, %FALSE otherwise.
    */
    -gboolean
    -_purple_network_set_common_socket_flags(int fd);
    +gboolean _purple_network_set_common_socket_flags(int fd);
    /**
    * purple_network_init: