Merge branch 'doc-types' into 'master'

doc: remove .types files and let gtkdoc-scan generate them

See merge request GNOME/glib!144
This commit is contained in:
Philip Withnall 2018-06-29 15:28:30 +00:00
commit 95082691d2
9 changed files with 112 additions and 254 deletions

View File

@ -8,6 +8,7 @@ DOC_MAIN_SGML_FILE=gio-docs.xml
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS = \
--rebuild-types \
--deprecated-guards="G_DISABLE_DEPRECATED" \
--ignore-decorators="GLIB_VAR|G_GNUC_INTERNAL|G_GNUC_WARN_UNUSED_RESULT|GLIB_AVAILABLE_IN_ALL|GLIB_AVAILABLE_IN_2_26|GLIB_AVAILABLE_IN_2_28|GLIB_AVAILABLE_IN_2_30|GLIB_AVAILABLE_IN_2_32|GLIB_AVAILABLE_IN_2_34|GLIB_AVAILABLE_IN_2_36|GLIB_AVAILABLE_IN_2_38|GLIB_AVAILABLE_IN_2_40|GLIB_AVAILABLE_IN_2_42|GLIB_AVAILABLE_IN_2_44|GLIB_AVAILABLE_IN_2_46|GLIB_AVAILABLE_IN_2_48|GLIB_AVAILABLE_IN_2_50|GLIB_AVAILABLE_IN_2_52|GLIB_AVAILABLE_IN_2_54|GLIB_AVAILABLE_IN_2_56|GLIB_DEPRECATED_IN_2_26|GLIB_DEPRECATED_IN_2_26_FOR|GLIB_DEPRECATED_IN_2_28|GLIB_DEPRECATED_IN_2_28_FOR|GLIB_DEPRECATED_IN_2_30|GLIB_DEPRECATED_IN_2_30_FOR|GLIB_DEPRECATED_IN_2_32|GLIB_DEPRECATED_IN_2_32_FOR|GLIB_DEPRECATED_IN_2_34|GLIB_DEPRECATED_IN_2_34_FOR|GLIB_DEPRECATED_IN_2_36|GLIB_DEPRECATED_IN_2_36_FOR|GLIB_DEPRECATED_IN_2_38|GLIB_DEPRECATED_IN_2_38_FOR|GLIB_DEPRECATED_IN_2_40|GLIB_DEPRECATED_IN_2_40_FOR|GLIB_DEPRECATED_IN_2_42|GLIB_DEPRECATED_IN_2_42_FOR|GLIB_DEPRECATED_IN_2_44|GLIB_DEPRECATED_IN_2_44_FOR|GLIB_DEPRECATED_IN_2_46|GLIB_DEPRECATED_IN_2_46_FOR|GLIB_DEPRECATED_IN_2_48|GLIB_DEPRECATED_IN_2_48_FOR|GLIB_DEPRECATED_IN_2_50|GLIB_DEPRECATED_IN_2_50_FOR|GLIB_DEPRECATED_IN_2_52|GLIB_DEPRECATED_IN_2_52_FOR|GLIB_DEPRECATED_IN_2_54|GLIB_DEPRECATED_IN_2_54_FOR|GLIB_DEPRECATED_IN_2_56|GLIB_DEPRECATED_IN_2_56_FOR"
@ -20,82 +21,115 @@ HFILE_GLOB= \
CFILE_GLOB=$(top_srcdir)/gio/*.c
IGNORE_HFILES = \
fam \
fen \
gdbus-2.0 \
gvdb \
inotify \
kqueue \
libasyncns \
tests \
win32 \
xdgmime \
gappinfoprivate.h \
gapplicationimpl.h \
gasynchelper.h \
gcontenttypeprivate.h \
gcontextspecificgroup.h \
gcredentialsprivate.h \
gdbus-daemon-generated.h \
gdbusactiongroup-private.h \
gdbusauth.h \
gdbusauthmechanismanon.h \
gdbusauthmechanismexternal.h \
gdbusauthmechanism.h \
gdbusauthmechanismsha1.h \
gdbusdaemon.h \
gdbusprivate.h \
gdelayedsettingsbackend.h \
gdummyfile.h \
gdummyproxyresolver.h \
gdummytlsbackend.h \
gfileattribute-priv.h \
gfileinfo-priv.h \
ghttpproxy.h \
gio_trace.h \
giomodule-priv.h \
gioprivate.h \
giowin32-priv.h \
glocaldirectorymonitor.h \
glocalfileenumerator.h \
glocalfile.h \
glocalfileinfo.h \
glocalfileinputstream.h \
glocalfileiostream.h \
glocalfilemonitor.h \
glocalfileoutputstream.h \
glocalvfs.h \
gmountprivate.h \
gnativevolumemonitor.h \
gnetworkingprivate.h \
gnetworkmonitorbase.h \
gnetworkmonitornetlink.h \
gnetworkmonitornm.h \
gnotificationbackend.h \
gnotification-private.h \
gpollfilemonitor.h \
gregistrysettingsbackend.h \
gresourcefile.h \
gsettingsbackendinternal.h \
gsettings-mapping.h \
gsettingsschema-internal.h \
gsocketinputstream.h \
gsocketoutputstream.h \
gsocks4aproxy.h \
gsocks4proxy.h \
gsocks5proxy.h \
gsubprocesslauncher-private.h \
gthreadedresolver.h \
gunionvolumemonitor.h \
gunixmount.h \
gunixresolver.h \
gunixvolume.h \
gunixvolumemonitor.h \
gwin32appinfo.h \
gwin32mount.h \
gwin32resolver.h \
gwin32volumemonitor.h \
thumbnail-verify.h
fam \
fen \
gdbus-2.0 \
gvdb \
inotify \
kqueue \
libasyncns \
tests \
win32 \
xdgmime \
gappinfoprivate.h \
gapplicationimpl.h \
gasynchelper.h \
gcontenttypeprivate.h \
gcontextspecificgroup.h \
gcredentialsprivate.h \
gdbus-daemon-generated.h \
gdbusactiongroup-private.h \
gdbusauth.h \
gdbusauthmechanismanon.h \
gdbusauthmechanismexternal.h \
gdbusauthmechanism.h \
gdbusauthmechanismsha1.h \
gdbusdaemon.h \
gdbusprivate.h \
gdelayedsettingsbackend.h \
gdummyfile.h \
gdummyproxyresolver.h \
gdummytlsbackend.h \
gfileattribute-priv.h \
gfileinfo-priv.h \
ghttpproxy.h \
giomodule-priv.h \
gioprivate.h \
giowin32-priv.h \
glocaldirectorymonitor.h \
glocalfileenumerator.h \
glocalfile.h \
glocalfileinfo.h \
glocalfileinputstream.h \
glocalfileiostream.h \
glocalfilemonitor.h \
glocalfileoutputstream.h \
glocalvfs.h \
gmountprivate.h \
gnativevolumemonitor.h \
gnetworkingprivate.h \
gnetworkmonitorbase.h \
gnetworkmonitornetlink.h \
gnetworkmonitornm.h \
gnetworkmonitorportal.h \
gnotificationbackend.h \
gnotification-private.h \
gpollfilemonitor.h \
gproxyresolverportal.h \
gregistrysettingsbackend.h \
gresourcefile.h \
gsettingsbackendinternal.h \
gsettings-mapping.h \
gsettingsschema-internal.h \
gsocketinputstream.h \
gsocketoutputstream.h \
gsocks4aproxy.h \
gsocks4proxy.h \
gsocks5proxy.h \
gsubprocesslauncher-private.h \
gthreadedresolver.h \
gunionvolumemonitor.h \
gunixmount.h \
gunixresolver.h \
gunixvolume.h \
gunixvolumemonitor.h \
gwin32appinfo.h \
gwin32mount.h \
gwin32registrykey.h \
gwin32resolver.h \
gwin32volumemonitor.h \
thumbnail-verify.h \
xdp-dbus.h \
$(NULL)
if OS_WIN32
IGNORE_HFILES += \
gfiledescriptorbased.h \
gunixconnection.h \
gunixcredentialsmessage.h \
gunixmounts.h \
gunixfdlist.h \
gunixfdmessage.h \
gunixinputstream.h \
gunixoutputstream.h \
gunixsocketaddress.h \
gdesktopappinfo.h \
gosxappinfo.h \
$(NULL)
else
if OS_COCOA
IGNORE_HFILES += gdesktopappinfo.h
else
IGNORE_HFILES += gosxappinfo.h
endif
IGNORE_HFILES += \
gwin32networkmonitor.h \
gwin32inputstream.h \
gwin32outputstream.h \
$(NULL)
endif
MKDB_IGNORE_FILES = \
gdbus-daemon-generated.c \

View File

@ -1,156 +0,0 @@
g_action_get_type
g_action_group_get_type
g_action_map_get_type
g_app_info_get_type
g_app_info_monitor_get_type
g_app_launch_context_get_type
g_application_command_line_get_type
g_application_get_type
g_async_initable_get_type
g_async_result_get_type
g_buffered_input_stream_get_type
g_buffered_output_stream_get_type
g_bytes_icon_get_type
g_cancellable_get_type
g_charset_converter_get_type
g_converter_get_type
g_converter_input_stream_get_type
g_converter_output_stream_get_type
g_credentials_get_type
g_data_input_stream_get_type
g_data_output_stream_get_type
g_dbus_action_group_get_type
g_dbus_annotation_info_get_type
g_dbus_arg_info_get_type
g_dbus_auth_observer_get_type
g_dbus_connection_get_type
g_dbus_interface_get_type
g_dbus_interface_info_get_type
g_dbus_interface_skeleton_get_type
g_dbus_menu_model_get_type
g_dbus_message_get_type
g_dbus_method_info_get_type
g_dbus_method_invocation_get_type
g_dbus_node_info_get_type
g_dbus_object_get_type
g_dbus_object_manager_client_get_type
g_dbus_object_manager_get_type
g_dbus_object_manager_server_get_type
g_dbus_object_proxy_get_type
g_dbus_object_skeleton_get_type
g_dbus_property_info_get_type
g_dbus_proxy_get_type
g_dbus_server_get_type
g_dbus_signal_info_get_type
g_desktop_app_info_get_type
g_desktop_app_info_lookup_get_type
g_drive_get_type
g_dtls_client_connection_get_type
g_dtls_connection_get_type
g_dtls_server_connection_get_type
g_emblem_get_type
g_emblemed_icon_get_type
g_file_attribute_info_list_get_type
g_file_attribute_matcher_get_type
g_file_descriptor_based_get_type
g_file_enumerator_get_type
g_file_get_type
g_file_icon_get_type
g_file_info_get_type
g_file_input_stream_get_type
g_file_io_stream_get_type
g_file_monitor_get_type
g_file_output_stream_get_type
g_filename_completer_get_type
g_filter_input_stream_get_type
g_filter_output_stream_get_type
g_icon_get_type
g_inet_address_get_type
g_inet_address_mask_get_type
g_inet_socket_address_get_type
g_initable_get_type
g_input_stream_get_type
g_io_module_get_type
g_io_stream_get_type
g_list_model_get_type
g_list_store_get_type
g_loadable_icon_get_type
g_memory_input_stream_get_type
g_memory_output_stream_get_type
g_menu_attribute_iter_get_type
g_menu_get_type
g_menu_item_get_type
g_menu_link_iter_get_type
g_menu_model_get_type
g_mount_get_type
g_mount_operation_get_type
g_network_address_get_type
g_network_monitor_get_type
g_network_service_get_type
g_notification_get_type
g_output_stream_get_type
g_permission_get_type
g_pollable_input_stream_get_type
g_pollable_output_stream_get_type
g_property_action_get_type
g_proxy_address_enumerator_get_type
g_proxy_address_get_type
g_proxy_get_type
g_proxy_resolver_get_type
g_remote_action_group_get_type
g_resolver_get_type
g_resource_get_type
g_seekable_get_type
g_settings_backend_get_type
g_settings_get_type
g_settings_schema_get_type
g_settings_schema_key_get_type
g_settings_schema_source_get_type
g_simple_action_get_type
g_simple_action_group_get_type
g_simple_async_result_get_type
g_simple_io_stream_get_type
g_simple_permission_get_type
g_simple_proxy_resolver_get_type
g_socket_address_enumerator_get_type
g_socket_address_get_type
g_socket_client_get_type
g_socket_connectable_get_type
g_socket_connection_get_type
g_socket_control_message_get_type
g_socket_get_type
g_socket_listener_get_type
g_socket_service_get_type
g_srv_target_get_type
g_subprocess_get_type
g_subprocess_launcher_get_type
g_task_get_type
g_tcp_connection_get_type
g_tcp_wrapper_connection_get_type
g_test_dbus_get_type
g_themed_icon_get_type
g_threaded_socket_service_get_type
g_tls_backend_get_type
g_tls_certificate_get_type
g_tls_client_connection_get_type
g_tls_connection_get_type
g_tls_database_get_type
g_tls_file_database_get_type
g_tls_interaction_get_type
g_tls_password_get_type
g_tls_server_connection_get_type
g_unix_connection_get_type
g_unix_credentials_message_get_type
g_unix_fd_list_get_type
g_unix_fd_message_get_type
g_unix_input_stream_get_type
g_unix_mount_entry_get_type
g_unix_mount_monitor_get_type
g_unix_mount_point_get_type
g_unix_output_stream_get_type
g_unix_socket_address_get_type
g_vfs_get_type
g_volume_get_type
g_volume_monitor_get_type
g_zlib_compressor_get_type
g_zlib_decompressor_get_type

View File

@ -182,7 +182,6 @@ if get_option('gtk_doc')
gnome.gtkdoc('gio',
main_xml : 'gio-docs.xml',
namespace : 'g',
gobject_typesfile : 'gio.types',
mode : 'none',
dependencies : [libgio_dep, libgobject_dep, libglib_dep],
src_dir : 'gio',

View File

@ -108,7 +108,6 @@ if get_option('gtk_doc')
src_dir : [ 'glib', 'gmodule' ],
dependencies : libglib_dep,
scan_args : [
'--rebuild-types',
'--deprecated-guards=G_DISABLE_DEPRECATED',
'--ignore-decorators=' + '|'.join(ignore_decorators),
'--ignore-headers=' + ' '.join(ignore_headers),

View File

@ -13,6 +13,7 @@ DOC_SOURCE_DIR =$(top_srcdir)/gobject $(top_builddir)/gobject
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS = \
--rebuild-types \
--deprecated-guards="G_DISABLE_DEPRECATED" \
--ignore-decorators="GLIB_VAR|G_GNUC_INTERNAL|G_GNUC_WARN_UNUSED_RESULT|GLIB_AVAILABLE_IN_ALL|GLIB_AVAILABLE_IN_2_26|GLIB_AVAILABLE_IN_2_28|GLIB_AVAILABLE_IN_2_30|GLIB_AVAILABLE_IN_2_32|GLIB_AVAILABLE_IN_2_34|GLIB_AVAILABLE_IN_2_36|GLIB_AVAILABLE_IN_2_38|GLIB_AVAILABLE_IN_2_40|GLIB_AVAILABLE_IN_2_42|GLIB_AVAILABLE_IN_2_44|GLIB_AVAILABLE_IN_2_46|GLIB_AVAILABLE_IN_2_48|GLIB_AVAILABLE_IN_2_50|GLIB_AVAILABLE_IN_2_52|GLIB_AVAILABLE_IN_2_54|GLIB_AVAILABLE_IN_2_56|GLIB_DEPRECATED_IN_2_26|GLIB_DEPRECATED_IN_2_26_FOR|GLIB_DEPRECATED_IN_2_28|GLIB_DEPRECATED_IN_2_28_FOR|GLIB_DEPRECATED_IN_2_30|GLIB_DEPRECATED_IN_2_30_FOR|GLIB_DEPRECATED_IN_2_32|GLIB_DEPRECATED_IN_2_32_FOR|GLIB_DEPRECATED_IN_2_34|GLIB_DEPRECATED_IN_2_34_FOR|GLIB_DEPRECATED_IN_2_36|GLIB_DEPRECATED_IN_2_36_FOR|GLIB_DEPRECATED_IN_2_38|GLIB_DEPRECATED_IN_2_38_FOR|GLIB_DEPRECATED_IN_2_40|GLIB_DEPRECATED_IN_2_40_FOR|GLIB_DEPRECATED_IN_2_42|GLIB_DEPRECATED_IN_2_42_FOR|GLIB_DEPRECATED_IN_2_44|GLIB_DEPRECATED_IN_2_44_FOR|GLIB_DEPRECATED_IN_2_46|GLIB_DEPRECATED_IN_2_46_FOR|GLIB_DEPRECATED_IN_2_48|GLIB_DEPRECATED_IN_2_48_FOR|GLIB_DEPRECATED_IN_2_50|GLIB_DEPRECATED_IN_2_50_FOR|GLIB_DEPRECATED_IN_2_52|GLIB_DEPRECATED_IN_2_52_FOR|GLIB_DEPRECATED_IN_2_54|GLIB_DEPRECATED_IN_2_54_FOR|GLIB_DEPRECATED_IN_2_56|GLIB_DEPRECATED_IN_2_56_FOR"
@ -64,7 +65,6 @@ include $(top_srcdir)/gtk-doc.make
# Other files to distribute
EXTRA_DIST += \
gobject.cI \
version.xml.in
########################################################################

View File

@ -1,11 +0,0 @@
/*
* This is a hack to work around a limitation of gtkdoc-scan: it insists
* on putting () behind every symbol listed in gobject.types. Thus we
* can't put G_TYPE_OBJECT there, but have to sneak a g_object_get_type()
* function in the generated source via an #include.
*/
GType
g_object_get_type (void)
{
return G_TYPE_OBJECT;
}

View File

@ -1,7 +0,0 @@
#include <glib/glib-object.h>
#include "gobject.cI"
g_binding_get_type
g_object_get_type
g_type_module_get_type
g_type_plugin_get_type

View File

@ -77,12 +77,12 @@ if get_option('gtk_doc')
gnome.gtkdoc('gobject',
main_xml : 'gobject-docs.xml',
namespace : 'g',
gobject_typesfile : join_paths(meson.current_source_dir(), 'gobject.types'),
mode : 'none',
dependencies : [libgobject_dep, libglib_dep],
include_directories : [gtkdocincl],
src_dir : 'gobject',
scan_args : [
'--rebuild-types',
'--deprecated-guards=G_DISABLE_DEPRECATED',
'--ignore-decorators=' + '|'.join(ignore_decorators),
'--ignore-headers=' + ' '.join(ignore_headers),