diff options
author | vpodshiv <vladimir.podshivalov@outlook.com> | 2020-05-11 22:56:11 +0200 |
---|---|---|
committer | Aleksander Morgado <aleksander@aleksander.es> | 2020-05-12 10:49:55 +0200 |
commit | 2aa0badc79595c92981793d18f05c99485156a6b (patch) | |
tree | 1297208ec401772e7d43554c05b02806c45b66ef | |
parent | 088997b6e407f539f1e1ba6afb7ffa62f83c8958 (diff) | |
download | libqmi-2aa0badc79595c92981793d18f05c99485156a6b.tar.gz |
build,libqmi-glib: integrate gobject-introspection, update doc helpers to comply with it
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | .gitlab-ci.yml | 19 | ||||
-rw-r--r-- | build-aux/qmi-codegen/VariableArray.py | 4 | ||||
-rw-r--r-- | build-aux/qmi-codegen/VariableInteger.py | 2 | ||||
-rw-r--r-- | build-aux/qmi-codegen/VariableString.py | 2 | ||||
-rw-r--r-- | build-aux/qmi-codegen/VariableStruct.py | 2 | ||||
-rw-r--r-- | configure.ac | 38 | ||||
-rw-r--r-- | m4/introspection.m4 | 97 | ||||
-rw-r--r-- | src/libqmi-glib/Makefile.am | 43 | ||||
-rw-r--r-- | src/libqmi-glib/qmi-device.h | 4 | ||||
-rw-r--r-- | src/libqmi-glib/qmi-errors.h | 26 | ||||
-rw-r--r-- | src/libqmi-glib/qmi-message.h | 54 |
12 files changed, 229 insertions, 64 deletions
@@ -4,6 +4,8 @@ *.la *.bz2 *.pyc +*.gir +*.typelib Makefile Makefile.in diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b58c3dae..e9d0f551 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -75,3 +75,22 @@ test-default: - make check - make install - make distcheck + +test-default-introspection: + stage: test + script: + - apt -y install gtk-doc-tools libglib2.0-doc gobject-introspection libgirepository1.0-dev + - git clone --depth 1 https://gitlab.freedesktop.org/mobile-broadband/libmbim.git + - pushd libmbim + - NOCONFIGURE=1 ./autogen.sh + - ./configure --prefix=/usr + - make + - make install + - popd + - NOCONFIGURE=1 ./autogen.sh + - ./configure --prefix=/usr --enable-gtk-doc --enable-mbim-qmux --enable-qrtr --enable-introspection=yes --disable-Werror + - make + - make check + - make install + - make distcheck + diff --git a/build-aux/qmi-codegen/VariableArray.py b/build-aux/qmi-codegen/VariableArray.py index 498947b0..630270c7 100644 --- a/build-aux/qmi-codegen/VariableArray.py +++ b/build-aux/qmi-codegen/VariableArray.py @@ -375,10 +375,10 @@ class VariableArray(Variable): template = '' if self.array_sequence_element != '': template += ( - '${lp}@${name}_sequence: a placeholder for the output sequence number, or %NULL if not required.\n') + '${lp}@${name}_sequence: (out): a placeholder for the output sequence number, or %NULL if not required.\n') template += ( - '${lp}@${name}: a placeholder for the output #GArray of #${public_array_element_format} elements, or %NULL if not required. Do not free it, it is owned by @self.\n') + '${lp}@${name}: (out): a placeholder for the output #GArray of #${public_array_element_format} elements, or %NULL if not required. Do not free it, it is owned by @self.\n') return string.Template(template).substitute(translations) diff --git a/build-aux/qmi-codegen/VariableInteger.py b/build-aux/qmi-codegen/VariableInteger.py index 97eb396e..79c6c184 100644 --- a/build-aux/qmi-codegen/VariableInteger.py +++ b/build-aux/qmi-codegen/VariableInteger.py @@ -296,7 +296,7 @@ class VariableInteger(Variable): 'name' : variable_name } template = ( - '${lp}@${name}: a placeholder for the output #${public_format}, or %NULL if not required.\n') + '${lp}@${name}: (out): a placeholder for the output #${public_format}, or %NULL if not required.\n') return string.Template(template).substitute(translations) """ diff --git a/build-aux/qmi-codegen/VariableString.py b/build-aux/qmi-codegen/VariableString.py index 1f6b958d..2dab7022 100644 --- a/build-aux/qmi-codegen/VariableString.py +++ b/build-aux/qmi-codegen/VariableString.py @@ -213,7 +213,7 @@ class VariableString(Variable): 'name' : variable_name } template = ( - '${lp}@${name}: a placeholder for the output constant string, or %NULL if not required.\n') + '${lp}@${name}: (out): a placeholder for the output constant string, or %NULL if not required.\n') return string.Template(template).substitute(translations) diff --git a/build-aux/qmi-codegen/VariableStruct.py b/build-aux/qmi-codegen/VariableStruct.py index 42fd430e..a125cff4 100644 --- a/build-aux/qmi-codegen/VariableStruct.py +++ b/build-aux/qmi-codegen/VariableStruct.py @@ -189,7 +189,7 @@ class VariableStruct(Variable): 'name' : variable_name } template = ( - '${lp}@${name}: a placeholder for the output constant #${format}, or %NULL if not required.\n') + '${lp}@${name}: (out): a placeholder for the output constant #${format}, or %NULL if not required.\n') return string.Template(template).substitute(translations) diff --git a/configure.ac b/configure.ac index c34310fa..bbcff8eb 100644 --- a/configure.ac +++ b/configure.ac @@ -109,6 +109,9 @@ AC_SUBST(GLIB_MKENUMS) AM_PATH_PYTHON([], [], [PYTHON=python]) +dnl GObject Introspection +GOBJECT_INTROSPECTION_CHECK([0.9.6]) + dnl message collection (existing file in data/qmi-collection-${COLLECTION}.json) dnl custom collections may be added as files in data/ AC_ARG_ENABLE(collection, @@ -296,27 +299,28 @@ echo " ============================================== Build: - compiler: ${CC} - cflags: ${CFLAGS} - ldflags: ${LDFLAGS} - warn cflags: ${WARN_CFLAGS} - warn ldflags: ${WARN_LDFLAGS} - Maintainer mode: ${USE_MAINTAINER_MODE} - Documentation: ${enable_gtk_doc} + compiler: ${CC} + cflags: ${CFLAGS} + ldflags: ${LDFLAGS} + warn cflags: ${WARN_CFLAGS} + warn ldflags: ${WARN_LDFLAGS} + Maintainer mode: ${USE_MAINTAINER_MODE} + Documentation: ${enable_gtk_doc} + gobject introspection: ${found_introspection} System paths: - prefix: ${prefix} - udev base directory: ${UDEV_BASE_DIR} + prefix: ${prefix} + udev base directory: ${UDEV_BASE_DIR} Features: - QMUX over MBIM: ${enable_mbim_qmux} - QMI username: ${QMI_USERNAME_ENABLED} (${QMI_USERNAME}) + QMUX over MBIM: ${enable_mbim_qmux} + QMI username: ${QMI_USERNAME_ENABLED} (${QMI_USERNAME}) Built items: - libqrtr-glib: ${enable_qrtr} - libqmi-glib: yes (${QMI_COLLECTION_NAME}) - qmicli: yes - qmi-firmware-update: ${build_firmware_update} - with udev: ${with_udev} - with MM runtime check: ${enable_mm_runtime_check} + libqrtr-glib: ${enable_qrtr} + libqmi-glib: yes (${QMI_COLLECTION_NAME}) + qmicli: yes + qmi-firmware-update: ${build_firmware_update} + with udev: ${with_udev} + with MM runtime check: ${enable_mm_runtime_check} " diff --git a/m4/introspection.m4 b/m4/introspection.m4 new file mode 100644 index 00000000..61f0cc38 --- /dev/null +++ b/m4/introspection.m4 @@ -0,0 +1,97 @@ +dnl -*- mode: autoconf -*- +dnl Copyright 2009 Johan Dahlin +dnl +dnl This file is free software; the author(s) gives unlimited +dnl permission to copy and/or distribute it, with or without +dnl modifications, as long as this notice is preserved. +dnl + +# serial 1 + +m4_define([_GOBJECT_INTROSPECTION_CHECK_INTERNAL], +[ + AC_BEFORE([AC_PROG_LIBTOOL],[$0])dnl setup libtool first + AC_BEFORE([AM_PROG_LIBTOOL],[$0])dnl setup libtool first + AC_BEFORE([LT_INIT],[$0])dnl setup libtool first + + dnl enable/disable introspection + m4_if([$2], [require], + [dnl + enable_introspection=yes + ],[dnl + AC_ARG_ENABLE(introspection, + AS_HELP_STRING([--enable-introspection[=@<:@no/auto/yes@:>@]], + [Enable introspection for this build]),, + [enable_introspection=auto]) + ])dnl + + AC_MSG_CHECKING([for gobject-introspection]) + + dnl presence/version checking + AS_CASE([$enable_introspection], + [no], [dnl + found_introspection="no (disabled, use --enable-introspection to enable)" + ],dnl + [yes],[dnl + PKG_CHECK_EXISTS([gobject-introspection-1.0],, + AC_MSG_ERROR([gobject-introspection-1.0 is not installed])) + PKG_CHECK_EXISTS([gobject-introspection-1.0 >= $1], + found_introspection=yes, + AC_MSG_ERROR([You need to have gobject-introspection >= $1 installed to build AC_PACKAGE_NAME])) + ],dnl + [auto],[dnl + PKG_CHECK_EXISTS([gobject-introspection-1.0 >= $1], found_introspection=yes, found_introspection=no) + dnl Canonicalize enable_introspection + enable_introspection=$found_introspection + ],dnl + [dnl + AC_MSG_ERROR([invalid argument passed to --enable-introspection, should be one of @<:@no/auto/yes@:>@]) + ])dnl + + AC_MSG_RESULT([$found_introspection]) + + INTROSPECTION_SCANNER= + INTROSPECTION_COMPILER= + INTROSPECTION_GENERATE= + INTROSPECTION_GIRDIR= + INTROSPECTION_TYPELIBDIR= + if test "x$found_introspection" = "xyes"; then + INTROSPECTION_SCANNER=`$PKG_CONFIG --variable=g_ir_scanner gobject-introspection-1.0` + INTROSPECTION_COMPILER=`$PKG_CONFIG --variable=g_ir_compiler gobject-introspection-1.0` + INTROSPECTION_GENERATE=`$PKG_CONFIG --variable=g_ir_generate gobject-introspection-1.0` + INTROSPECTION_GIRDIR=`$PKG_CONFIG --variable=girdir gobject-introspection-1.0` + INTROSPECTION_TYPELIBDIR="$($PKG_CONFIG --variable=typelibdir gobject-introspection-1.0)" + INTROSPECTION_CFLAGS=`$PKG_CONFIG --cflags gobject-introspection-1.0` + INTROSPECTION_LIBS=`$PKG_CONFIG --libs gobject-introspection-1.0` + INTROSPECTION_MAKEFILE=`$PKG_CONFIG --variable=datadir gobject-introspection-1.0`/gobject-introspection-1.0/Makefile.introspection + fi + AC_SUBST(INTROSPECTION_SCANNER) + AC_SUBST(INTROSPECTION_COMPILER) + AC_SUBST(INTROSPECTION_GENERATE) + AC_SUBST(INTROSPECTION_GIRDIR) + AC_SUBST(INTROSPECTION_TYPELIBDIR) + AC_SUBST(INTROSPECTION_CFLAGS) + AC_SUBST(INTROSPECTION_LIBS) + AC_SUBST(INTROSPECTION_MAKEFILE) + + AM_CONDITIONAL(HAVE_INTROSPECTION, test "x$found_introspection" = "xyes") +]) + + +dnl Usage: +dnl GOBJECT_INTROSPECTION_CHECK([minimum-g-i-version]) + +AC_DEFUN([GOBJECT_INTROSPECTION_CHECK], +[ + _GOBJECT_INTROSPECTION_CHECK_INTERNAL([$1]) +]) + +dnl Usage: +dnl GOBJECT_INTROSPECTION_REQUIRE([minimum-g-i-version]) + + +AC_DEFUN([GOBJECT_INTROSPECTION_REQUIRE], +[ + _GOBJECT_INTROSPECTION_CHECK_INTERNAL([$1], [require]) +]) + diff --git a/src/libqmi-glib/Makefile.am b/src/libqmi-glib/Makefile.am index 01e75789..9368f25f 100644 --- a/src/libqmi-glib/Makefile.am +++ b/src/libqmi-glib/Makefile.am @@ -145,3 +145,46 @@ include_HEADERS = \ EXTRA_DIST = \ qmi-version.h.in + +CLEANFILES = + +# Introspection + +if HAVE_INTROSPECTION + +INTROSPECTION_GIRS = libqmi-glib.gir +INTROSPECTION_SCANNER_ARGS = --warn-all +INTROSPECTION_COMPILER_ARGS = + +libqmi-glib.gir: libqmi-glib.la +libqmi_glib_gir_INCLUDES = GLib-2.0 GObject-2.0 Gio-2.0 +libqmi_glib_gir_CFLAGS = $(libqmi_glib_la_CPPFLAGS) +libqmi_glib_gir_LIBS = libqmi-glib.la +libqmi_glib_gir_EXPORT_PACKAGES = libqmi-glib +libqmi_glib_gir_SCANNERFLAGS = \ + $(WARN_SCANNERFLAGS) \ + --c-include "libqmi-glib.h" \ + --identifier-prefix=QMI \ + --identifier-prefix=Qmi \ + --symbol-prefix=qmi_ \ + $(NULL) +libqmi_glib_gir_FILES = \ + $(include_HEADERS) \ + $(filter-out %.h,$(libmm_glib_la_SOURCES)) \ + $(filter %.c,$(libmm_glib_la_SOURCES)) \ + $(wildcard generated/*.h) \ + $(wildcard generated/*.c) \ + $(NULL) + +girdir = $(datadir)/gir-1.0 +nodist_gir_DATA = $(INTROSPECTION_GIRS) + +typelibdir = $(libdir)/girepository-1.0 +nodist_typelib_DATA = $(INTROSPECTION_GIRS:.gir=.typelib) + +CLEANFILES += $(nodist_gir_DATA) $(nodist_typelib_DATA) + +endif # HAVE_INTROSPECTION + +-include $(INTROSPECTION_MAKEFILE) + diff --git a/src/libqmi-glib/qmi-device.h b/src/libqmi-glib/qmi-device.h index 3b8a96a4..ad3e5712 100644 --- a/src/libqmi-glib/qmi-device.h +++ b/src/libqmi-glib/qmi-device.h @@ -405,7 +405,7 @@ void qmi_device_allocate_client (QmiDevice *self, * * Finishes an operation started with qmi_device_allocate_client(). * - * Returns: a newly allocated #QmiClient, or %NULL if @error is set. + * Returns: (transfer full): a newly allocated #QmiClient, or %NULL if @error is set. * * Since: 1.0 */ @@ -617,7 +617,7 @@ void qmi_device_command_full (QmiDevice *self, * * Finishes an operation started with qmi_device_command_full(). * - * Returns: a #QmiMessage response, or %NULL if @error is set. The returned value should be freed with qmi_message_unref(). + * Returns: (transfer full): a #QmiMessage response, or %NULL if @error is set. The returned value should be freed with qmi_message_unref(). * * Since: 1.18 */ diff --git a/src/libqmi-glib/qmi-errors.h b/src/libqmi-glib/qmi-errors.h index a2a22ca5..79479ab7 100644 --- a/src/libqmi-glib/qmi-errors.h +++ b/src/libqmi-glib/qmi-errors.h @@ -269,7 +269,7 @@ typedef enum { /*< underscore_name=qmi_protocol_error >*/ QMI_PROTOCOL_ERROR_UIM_UNINITIALIZED = 37, /*< nick=UimUninitialized >*/ QMI_PROTOCOL_ERROR_MAXIMUM_QOS_REQUESTS_IN_USE = 38, /*< nick=MaximumQosRequestsInUse >*/ QMI_PROTOCOL_ERROR_INCORRECT_FLOW_FILTER = 39, /*< nick=IncorrectFlowFilter >*/ - QMI_PROTOCOL_ERROR_NETWORK_QOS_UNAWARE = 40, /*< nick= NetworkQosUnaware >*/ + QMI_PROTOCOL_ERROR_NETWORK_QOS_UNAWARE = 40, /*< nick=NetworkQosUnaware >*/ QMI_PROTOCOL_ERROR_INVALID_QOS_ID = 41, /*< nick=InvalidQosId >*/ QMI_PROTOCOL_ERROR_REQUESTED_NUMBER_UNSUPPORTED = 42, /*< nick=RequestedNumberUnsupported >*/ QMI_PROTOCOL_ERROR_INTERFACE_NOT_FOUND = 43, /*< nick=InterfaceNotFound >*/ @@ -283,11 +283,11 @@ typedef enum { /*< underscore_name=qmi_protocol_error >*/ QMI_PROTOCOL_ERROR_DEVICE_STORAGE_FULL = 51, /*< nick=DeviceStorageFull >*/ QMI_PROTOCOL_ERROR_DEVICE_NOT_READY = 52, /*< nick=DeviceNotReady >*/ QMI_PROTOCOL_ERROR_NETWORK_NOT_READY = 53, /*< nick=NetworkNotReady >*/ - QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE = 54, /*< nick=Wms.CauseCode >*/ - QMI_PROTOCOL_ERROR_WMS_MESSAGE_NOT_SENT = 55, /*< nick=Wms.MessageNotSent >*/ - QMI_PROTOCOL_ERROR_WMS_MESSAGE_DELIVERY_FAILURE = 56, /*< nick=Wms.MessageDeliveryFailure >*/ - QMI_PROTOCOL_ERROR_WMS_INVALID_MESSAGE_ID = 57, /*< nick=Wms.InvalidMessageId >*/ - QMI_PROTOCOL_ERROR_WMS_ENCODING = 58, /*< nick=Wms.Encoding >*/ + QMI_PROTOCOL_ERROR_WMS_CAUSE_CODE = 54, /*< nick=WmsCauseCode >*/ + QMI_PROTOCOL_ERROR_WMS_MESSAGE_NOT_SENT = 55, /*< nick=WmsMessageNotSent >*/ + QMI_PROTOCOL_ERROR_WMS_MESSAGE_DELIVERY_FAILURE = 56, /*< nick=WmsMessageDeliveryFailure >*/ + QMI_PROTOCOL_ERROR_WMS_INVALID_MESSAGE_ID = 57, /*< nick=WmsInvalidMessageId >*/ + QMI_PROTOCOL_ERROR_WMS_ENCODING = 58, /*< nick=WmsEncoding >*/ QMI_PROTOCOL_ERROR_AUTHENTICATION_LOCK = 59, /*< nick=AuthenticationLock >*/ QMI_PROTOCOL_ERROR_INVALID_TRANSITION = 60, /*< nick=InvalidTransition >*/ QMI_PROTOCOL_ERROR_NOT_MCAST_INTERFACE = 61, /*< nick=NotMcastInterface >*/ @@ -301,8 +301,8 @@ typedef enum { /*< underscore_name=qmi_protocol_error >*/ QMI_PROTOCOL_ERROR_DISABLED = 69, /*< nick=Disabled >*/ QMI_PROTOCOL_ERROR_INVALID_OPERATION = 70, /*< nick=InvalidOperation >*/ QMI_PROTOCOL_ERROR_INVALID_QMI_COMMAND = 71, /*< nick=InvalidQmiCommand >*/ - QMI_PROTOCOL_ERROR_WMS_T_PDU_TYPE = 72, /*< nick=Wms.TPduType >*/ - QMI_PROTOCOL_ERROR_WMS_SMSC_ADDRESS = 73, /*< nick=Wms.SmscAddress >*/ + QMI_PROTOCOL_ERROR_WMS_T_PDU_TYPE = 72, /*< nick=WmsTPduType >*/ + QMI_PROTOCOL_ERROR_WMS_SMSC_ADDRESS = 73, /*< nick=WmsSmscAddress >*/ QMI_PROTOCOL_ERROR_INFORMATION_UNAVAILABLE = 74, /*< nick=InformationUnavailable >*/ QMI_PROTOCOL_ERROR_SEGMENT_TOO_LONG = 75, /*< nick=SegmentTooLong >*/ QMI_PROTOCOL_ERROR_SEGMENT_ORDER = 76, /*< nick=SegmentOrder >*/ @@ -352,11 +352,11 @@ typedef enum { /*< underscore_name=qmi_protocol_error >*/ QMI_PROTOCOL_ERROR_FW_FILE_OPEN_FAILED = 400, /*< nick=FwFileOpenFailed >*/ QMI_PROTOCOL_ERROR_FW_UPDATE_DISCONTINUOUS_FRAME = 401, /*< nick=FwUpdateDiscontinuousFrame >*/ QMI_PROTOCOL_ERROR_FW_UPDATE_FAILED = 402, /*< nick=FwUpdateFailed >*/ - QMI_PROTOCOL_ERROR_CAT_EVENT_REGISTRATION_FAILED = 61441, /*< nick=Cat.EventRegistrationFailed >*/ - QMI_PROTOCOL_ERROR_CAT_INVALID_TERMINAL_RESPONSE = 61442, /*< nick=Cat.InvalidTerminalResponse >*/ - QMI_PROTOCOL_ERROR_CAT_INVALID_ENVELOPE_COMMAND = 61443, /*< nick=Cat.InvalidEnvelopeCommand >*/ - QMI_PROTOCOL_ERROR_CAT_ENVELOPE_COMMAND_BUSY = 61444, /*< nick=Cat.EnvelopCommandBusy >*/ - QMI_PROTOCOL_ERROR_CAT_ENVELOPE_COMMAND_FAILED = 61445 /*< nick=Cat.EnvelopeCommandFailed >*/ + QMI_PROTOCOL_ERROR_CAT_EVENT_REGISTRATION_FAILED = 61441, /*< nick=CatEventRegistrationFailed >*/ + QMI_PROTOCOL_ERROR_CAT_INVALID_TERMINAL_RESPONSE = 61442, /*< nick=CatInvalidTerminalResponse >*/ + QMI_PROTOCOL_ERROR_CAT_INVALID_ENVELOPE_COMMAND = 61443, /*< nick=CatInvalidEnvelopeCommand >*/ + QMI_PROTOCOL_ERROR_CAT_ENVELOPE_COMMAND_BUSY = 61444, /*< nick=CatEnvelopeCommandBusy >*/ + QMI_PROTOCOL_ERROR_CAT_ENVELOPE_COMMAND_FAILED = 61445 /*< nick=CatEnvelopeCommandFailed >*/ } QmiProtocolError; /** diff --git a/src/libqmi-glib/qmi-message.h b/src/libqmi-glib/qmi-message.h index 72f73e78..8e8c0c36 100644 --- a/src/libqmi-glib/qmi-message.h +++ b/src/libqmi-glib/qmi-message.h @@ -577,7 +577,7 @@ gboolean qmi_message_tlv_write_string (QmiMessage *self, * qmi_message_tlv_read_init: * @self: a #QmiMessage. * @type: specific ID of the TLV to read. - * @out_tlv_length: optional return location for the TLV size. + * @out_tlv_length: (out): optional return location for the TLV size. * @error: return location for error or %NULL. * * Starts reading a given TLV from the #QmiMessage. @@ -595,8 +595,8 @@ gsize qmi_message_tlv_read_init (QmiMessage *self, * qmi_message_tlv_read_guint8: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of the offset within the TLV value. - * @out: return location for the read #guint8. + * @offset: (inout): address of the offset within the TLV value. + * @out: (out): return location for the read #guint8. * @error: return location for error or %NULL. * * Reads an unsigned byte from the TLV. @@ -619,8 +619,8 @@ gboolean qmi_message_tlv_read_guint8 (QmiMessage *self, * qmi_message_tlv_read_gint8: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. - * @out: return location for the read #gint8. + * @offset: (inout): address of a the offset within the TLV value. + * @out: (out): return location for the read #gint8. * @error: return location for error or %NULL. * * Reads a signed byte from the TLV. @@ -643,9 +643,9 @@ gboolean qmi_message_tlv_read_gint8 (QmiMessage *self, * qmi_message_tlv_read_guint16: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #guint16. + * @out: (out): return location for the read #guint16. * @error: return location for error or %NULL. * * Reads an unsigned 16-bit integer from the TLV, in host byte order. @@ -669,9 +669,9 @@ gboolean qmi_message_tlv_read_guint16 (QmiMessage *self, * qmi_message_tlv_read_gint16: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #gint16. + * @out: (out): return location for the read #gint16. * @error: return location for error or %NULL. * * Reads a signed 16-bit integer from the TLV, in host byte order. @@ -695,9 +695,9 @@ gboolean qmi_message_tlv_read_gint16 (QmiMessage *self, * qmi_message_tlv_read_guint32: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #guint32. + * @out: (out): return location for the read #guint32. * @error: return location for error or %NULL. * * Reads an unsigned 32-bit integer from the TLV, in host byte order. @@ -721,9 +721,9 @@ gboolean qmi_message_tlv_read_guint32 (QmiMessage *self, * qmi_message_tlv_read_gint32: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #gint32. + * @out: (out): return location for the read #gint32. * @error: return location for error or %NULL. * * Reads a signed 32-bit integer from the TLV, in host byte order. @@ -747,9 +747,9 @@ gboolean qmi_message_tlv_read_gint32 (QmiMessage *self, * qmi_message_tlv_read_guint64: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #guint64. + * @out: (out): return location for the read #guint64. * @error: return location for error or %NULL. * * Reads an unsigned 64-bit integer from the TLV, in host byte order. @@ -773,9 +773,9 @@ gboolean qmi_message_tlv_read_guint64 (QmiMessage *self, * qmi_message_tlv_read_gint64: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #gint64. + * @out: (out): return location for the read #gint64. * @error: return location for error or %NULL. * * Reads a signed 64-bit integer from the TLV, in host byte order. @@ -799,10 +799,10 @@ gboolean qmi_message_tlv_read_gint64 (QmiMessage *self, * qmi_message_tlv_read_sized_guint: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @n_bytes: number of bytes to read. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #guint64. + * @out: (out): return location for the read #guint64. * @error: return location for error or %NULL. * * Reads a @b_bytes-sized integer from the TLV, in host byte order. @@ -827,9 +827,9 @@ gboolean qmi_message_tlv_read_sized_guint (QmiMessage *self, * qmi_message_tlv_read_gfloat_endian: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #gfloat. + * @out: (out): return location for the read #gfloat. * @error: return location for error or %NULL. * * Reads a 32-bit floating-point number from the TLV. @@ -853,9 +853,9 @@ gboolean qmi_message_tlv_read_gfloat_endian (QmiMessage *self, * qmi_message_tlv_read_gdouble: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @endian: source endianness, which will be swapped to host byte order if necessary. - * @out: return location for the read #gdouble. + * @out: (out): return location for the read #gdouble. * @error: return location for error or %NULL. * * Reads a 64-bit floating-point number from the TLV. @@ -879,10 +879,10 @@ gboolean qmi_message_tlv_read_gdouble (QmiMessage *self, * qmi_message_tlv_read_string: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @n_size_prefix_bytes: number of bytes used in the size prefix. * @max_size: maximum number of bytes to read, or 0 to read all available bytes. - * @out: return location for the read string. The returned value should be freed with g_free(). + * @out: (out): return location for the read string. The returned value should be freed with g_free(). * @error: return location for error or %NULL. * * Reads a string from the TLV. @@ -912,9 +912,9 @@ gboolean qmi_message_tlv_read_string (QmiMessage *self, * qmi_message_tlv_read_fixed_size_string: * @self: a #QmiMessage. * @tlv_offset: offset that was returned by qmi_message_tlv_read_init(). - * @offset: address of a the offset within the TLV value. + * @offset: (inout): address of a the offset within the TLV value. * @string_length: amount of bytes to read. - * @out: buffer preallocated by the client, with at least @string_length bytes. + * @out: (out): buffer preallocated by the client, with at least @string_length bytes. * @error: return location for error or %NULL. * * Reads a string from the TLV. |