From ae7640c7ab5595fa43ef7605b6f9e1ff7352d849 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Corentin=20No=C3=ABl?= Date: Wed, 27 Mar 2019 16:27:23 +0100 Subject: docs: Modernize the libtracker-miner documentation --- .../libtracker-miner/libtracker-miner-docs.sgml | 56 ----- .../libtracker-miner/libtracker-miner-docs.xml | 111 ++++++++++ .../libtracker-miner/libtracker-miner-sections.txt | 228 --------------------- .../libtracker-miner/libtracker-miner.types | 7 - docs/reference/libtracker-miner/meson.build | 6 +- docs/reference/libtracker-miner/overview.sgml | 52 ----- docs/reference/libtracker-miner/overview.xml | 52 +++++ 7 files changed, 166 insertions(+), 346 deletions(-) delete mode 100644 docs/reference/libtracker-miner/libtracker-miner-docs.sgml create mode 100644 docs/reference/libtracker-miner/libtracker-miner-docs.xml delete mode 100644 docs/reference/libtracker-miner/libtracker-miner-sections.txt delete mode 100644 docs/reference/libtracker-miner/libtracker-miner.types delete mode 100644 docs/reference/libtracker-miner/overview.sgml create mode 100644 docs/reference/libtracker-miner/overview.xml diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml b/docs/reference/libtracker-miner/libtracker-miner-docs.sgml deleted file mode 100644 index 5dbfe4780..000000000 --- a/docs/reference/libtracker-miner/libtracker-miner-docs.sgml +++ /dev/null @@ -1,56 +0,0 @@ - - - -]> - - - Tracker Miner Library Reference Manual - - for libtracker-miner &version;. - The latest version of this documentation can be found on-line at - - http://library.gnome.org/devel/libtracker-miner/unstable - . - - - - - - - - - Reference - - - This section provides the detailed API of the Tracker Miner library. - - - - - Base abstract miner classes - - - - - - - - - Miner classes for file system - - - - - - - DBus helpers - - - - - - - - diff --git a/docs/reference/libtracker-miner/libtracker-miner-docs.xml b/docs/reference/libtracker-miner/libtracker-miner-docs.xml new file mode 100644 index 000000000..2ef95978a --- /dev/null +++ b/docs/reference/libtracker-miner/libtracker-miner-docs.xml @@ -0,0 +1,111 @@ + + + +]> + + + Tracker Miner Library Reference Manual + + for libtracker-miner &version;. + The latest version of this documentation can be found on-line at + + https://developer.gnome.org/libtracker-miner/stable + . + + + + + + + + + Reference + + + This section provides the detailed API of the Tracker Miner library. + + + + + Base abstract miner classes + + + + + + + + + Miner classes for file system + + + + + + + + + + + + + + + DBus helpers + + + + + + + + + Index + + + + Index of deprecated symbols + + + + Index of new symbols in 0.8 + + + + Index of new symbols in 0.10 + + + + Index of new symbols in 0.12 + + + + Index of new symbols in 0.14 + + + + Index of new symbols in 0.18 + + + + Index of new symbols in 1.2 + + + + Index of new symbols in 1.2.2 + + + + Index of new symbols in 1.10 + + + + Index of new symbols in 2.0 + + + + + diff --git a/docs/reference/libtracker-miner/libtracker-miner-sections.txt b/docs/reference/libtracker-miner/libtracker-miner-sections.txt deleted file mode 100644 index d5b74d20e..000000000 --- a/docs/reference/libtracker-miner/libtracker-miner-sections.txt +++ /dev/null @@ -1,228 +0,0 @@ -
-tracker-data-provider -TrackerDataProvider -TrackerDataProviderIface -tracker_data_provider_begin -tracker_data_provider_begin_async -tracker_data_provider_begin_finish -TrackerDataProvider - -TRACKER_DATA_PROVIDER -TRACKER_DATA_PROVIDER_GET_IFACE -TRACKER_IS_DATA_PROVIDER -TRACKER_TYPE_DATA_PROVIDER -tracker_data_provider_get_type -
- -
-tracker-decorator -TrackerDecorator -TrackerDecorator -TrackerDecoratorClass -TrackerDecoratorError -tracker_decorator_error_quark -tracker_decorator_get_data_source -tracker_decorator_get_class_names -tracker_decorator_get_n_items -tracker_decorator_prepend_id -tracker_decorator_delete_id -tracker_decorator_next -tracker_decorator_next_finish -tracker_decorator_set_priority_rdf_types -tracker_decorator_info_ref -tracker_decorator_info_unref -tracker_decorator_info_get_urn -tracker_decorator_info_get_url -tracker_decorator_info_get_mimetype -tracker_decorator_info_get_task -tracker_decorator_info_complete -tracker_decorator_info_complete_error - -TRACKER_DECORATOR -TRACKER_DECORATOR_CLASS -TRACKER_DECORATOR_GET_CLASS -TRACKER_IS_DECORATOR -TRACKER_IS_DECORATOR_CLASS -TRACKER_TYPE_DECORATOR -TrackerDecoratorInfo -tracker_decorator_get_type -tracker_decorator_info_get_type -
- -
-tracker-decorator-fs -TrackerDecoratorFS -TrackerDecoratorFS -TrackerDecoratorFSClass -tracker_decorator_fs_prepend_file - -TRACKER_DECORATOR_FS -TRACKER_DECORATOR_FS_CLASS -TRACKER_DECORATOR_FS_GET_CLASS -TRACKER_IS_DECORATOR_FS -TRACKER_IS_DECORATOR_FS_CLASS -TRACKER_TYPE_DECORATOR_FS -tracker_decorator_fs_get_type -
- -
-tracker-file-data-provider -TrackerFileDataProvider -TrackerFileDataProviderClass -tracker_file_data_provider_new -TrackerFileDataProvider - -TRACKER_FILE_DATA_PROVIDER -TRACKER_FILE_DATA_PROVIDER_CLASS -TRACKER_FILE_DATA_PROVIDER_GET_CLASS -TRACKER_IS_FILE_DATA_PROVIDER -TRACKER_IS_FILE_DATA_PROVIDER_CLASS -TRACKER_TYPE_FILE_DATA_PROVIDER -TrackerFileDataProviderPrivate -tracker_file_data_provider_get_type -
- -
-tracker-indexing-tree -TrackerIndexingTree -TrackerIndexingTree -TrackerIndexingTreeClass -tracker_indexing_tree_new -tracker_indexing_tree_new_with_root -tracker_indexing_tree_add -tracker_indexing_tree_remove -tracker_indexing_tree_add_filter -tracker_indexing_tree_clear_filters -tracker_indexing_tree_file_matches_filter -tracker_indexing_tree_file_is_indexable -tracker_indexing_tree_parent_is_indexable -tracker_indexing_tree_get_filter_hidden -tracker_indexing_tree_set_filter_hidden -tracker_indexing_tree_get_default_policy -tracker_indexing_tree_set_default_policy -tracker_indexing_tree_get_root -tracker_indexing_tree_get_master_root -tracker_indexing_tree_file_is_root -tracker_indexing_tree_list_roots -tracker_indexing_tree_notify_update - -TRACKER_INDEXING_TREE -TRACKER_INDEXING_TREE_CLASS -TRACKER_INDEXING_TREE_GET_CLASS -TRACKER_IS_INDEXING_TREE -TRACKER_IS_INDEXING_TREE_CLASS -TRACKER_TYPE_INDEXING_TREE -tracker_indexing_tree_get_type -
- -
-tracker-miner-enum-types - -TRACKER_TYPE_DIRECTORY_FLAGS -TRACKER_TYPE_FILTER_POLICY -TRACKER_TYPE_FILTER_TYPE -TRACKER_TYPE_NETWORK_TYPE -tracker_directory_flags_get_type -tracker_filter_policy_get_type -tracker_filter_type_get_type -tracker_network_type_get_type -
- -
-tracker-miner-enums -TrackerDirectoryFlags -TrackerFilterType -TrackerFilterPolicy -TrackerNetworkType -
- -
-tracker-miner-fs -TrackerMinerFS -TrackerMinerFS -TrackerMinerFSClass -TrackerMinerFSError -TrackerMinerFSEventType -tracker_miner_fs_error_quark -tracker_miner_fs_get_indexing_tree -tracker_miner_fs_get_data_provider -tracker_miner_fs_get_throttle -tracker_miner_fs_set_throttle -tracker_miner_fs_check_file -tracker_miner_fs_notify_finish -tracker_miner_fs_get_urn -tracker_miner_fs_query_urn -tracker_miner_fs_has_items_to_process - -TRACKER_IS_MINER_FS -TRACKER_IS_MINER_FS_CLASS -TRACKER_MINER_FS -TRACKER_MINER_FS_CLASS -TRACKER_MINER_FS_GET_CLASS -TRACKER_TYPE_MINER_FS -TrackerMinerFSPrivate -tracker_miner_fs_get_type -
- -
-tracker-miner-object -TrackerMiner -TRACKER_MINER_DBUS_INTERFACE -TRACKER_MINER_DBUS_NAME_PREFIX -TRACKER_MINER_DBUS_PATH_PREFIX -TRACKER_MINER_ERROR_DOMAIN -TRACKER_MINER_ERROR -TrackerMiner -TrackerMinerClass -TrackerMinerError -tracker_miner_error_quark -tracker_miner_start -tracker_miner_stop -tracker_miner_is_started -tracker_miner_is_paused -tracker_miner_pause -tracker_miner_resume -tracker_miner_get_connection - -TRACKER_IS_MINER -TRACKER_IS_MINER_CLASS -TRACKER_MINER -TRACKER_MINER_CLASS -TRACKER_MINER_GET_CLASS -TRACKER_TYPE_MINER -TrackerMinerPrivate -tracker_miner_get_type -
- -
-tracker-miner-online -TrackerMinerOnline -TrackerMinerOnline -TrackerMinerOnlineClass -tracker_miner_online_get_network_type - -TRACKER_IS_MINER_ONLINE -TRACKER_IS_MINER_ONLINE_CLASS -TRACKER_MINER_ONLINE -TRACKER_MINER_ONLINE_CLASS -TRACKER_MINER_ONLINE_GET_CLASS -TRACKER_TYPE_MINER_ONLINE -tracker_miner_online_get_type -
- -
-tracker-miner-proxy -TrackerMinerProxy -TrackerMinerProxy -TrackerMinerProxyClass -tracker_miner_proxy_new - -TRACKER_IS_MINER_PROXY -TRACKER_IS_MINER_PROXY_CLASS -TRACKER_MINER_PROXY -TRACKER_MINER_PROXY_CLASS -TRACKER_MINER_PROXY_GET_CLASS -TRACKER_TYPE_MINER_PROXY -tracker_miner_proxy_get_type -
- diff --git a/docs/reference/libtracker-miner/libtracker-miner.types b/docs/reference/libtracker-miner/libtracker-miner.types deleted file mode 100644 index 8cff4f654..000000000 --- a/docs/reference/libtracker-miner/libtracker-miner.types +++ /dev/null @@ -1,7 +0,0 @@ -tracker_decorator_get_type -tracker_decorator_fs_get_type -tracker_indexing_tree_get_type -tracker_miner_get_type -tracker_miner_fs_get_type -tracker_miner_online_get_type -tracker_miner_proxy_get_type diff --git a/docs/reference/libtracker-miner/meson.build b/docs/reference/libtracker-miner/meson.build index 5f748303f..30bcb43b5 100644 --- a/docs/reference/libtracker-miner/meson.build +++ b/docs/reference/libtracker-miner/meson.build @@ -4,9 +4,9 @@ version_xml = configure_file(input: 'version.xml.in', gnome.gtkdoc('libtracker-miner', src_dir: minerinc, - main_sgml: 'libtracker-miner-docs.sgml', - content_files: ['overview.sgml', 'migrating-1to2.xml'], + main_xml: 'libtracker-miner-docs.xml', + content_files: ['overview.xml', 'migrating-1to2.xml'], dependencies: tracker_miner_dep, - gobject_typesfile: 'libtracker-miner.types', + scan_args: ['--rebuild-sections'], fixxref_args: fixxref_args, install: true) diff --git a/docs/reference/libtracker-miner/overview.sgml b/docs/reference/libtracker-miner/overview.sgml deleted file mode 100644 index 5becdcd14..000000000 --- a/docs/reference/libtracker-miner/overview.sgml +++ /dev/null @@ -1,52 +0,0 @@ - - - - Overview - - - The libtracker-miner library is the foundation for Tracker data miners, - these miners will extract metadata and insert it in SPARQL form to - a TrackerSparqlConnection. - - - The abstract objects provided by this library implement the data indexing - logic necessary for different data and patterns. They merely provide the - guidelines, SPARQL updates are also possible without a libtracker-miner - object implementation. - - - - - Compiling applications - - - To compile applications using libtracker-miner, you - need to tell the compiler where to find the proper header files - and libraries. This is done with the - pkg-config utility. - - - - The following interactive shell session demonstrates how - pkg-config is used (the actual output on - your system may be different): - -$ pkg-config --cflags tracker-miner-2.0 --pthread -I/usr/include/tracker-2.0 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/tracker-2.0/libtracker-sparql - -$ pkg-config --libs tracker-miner-2.0 --pthread -Wl,--export-dynamic -ltracker-miner-2.0 -ltracker-sparql-2.0 -lgio-2.0 -lgobject-2.0 -lgmodule-2.0 -lgthread-2.0 -lrt -lglib-2.0 - - - - - The simplest way to compile a program is to use the "backticks" - feature of the shell. If you enclose a command in backticks - (not single quotes), then its output will be - substituted into the command line before execution: - - $ cc `pkg-config --cflags --libs tracker-miner-2.0` hello.c -o hello - - - - diff --git a/docs/reference/libtracker-miner/overview.xml b/docs/reference/libtracker-miner/overview.xml new file mode 100644 index 000000000..5becdcd14 --- /dev/null +++ b/docs/reference/libtracker-miner/overview.xml @@ -0,0 +1,52 @@ + + + + Overview + + + The libtracker-miner library is the foundation for Tracker data miners, + these miners will extract metadata and insert it in SPARQL form to + a TrackerSparqlConnection. + + + The abstract objects provided by this library implement the data indexing + logic necessary for different data and patterns. They merely provide the + guidelines, SPARQL updates are also possible without a libtracker-miner + object implementation. + + + + + Compiling applications + + + To compile applications using libtracker-miner, you + need to tell the compiler where to find the proper header files + and libraries. This is done with the + pkg-config utility. + + + + The following interactive shell session demonstrates how + pkg-config is used (the actual output on + your system may be different): + +$ pkg-config --cflags tracker-miner-2.0 +-pthread -I/usr/include/tracker-2.0 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include -I/usr/include/tracker-2.0/libtracker-sparql + +$ pkg-config --libs tracker-miner-2.0 +-pthread -Wl,--export-dynamic -ltracker-miner-2.0 -ltracker-sparql-2.0 -lgio-2.0 -lgobject-2.0 -lgmodule-2.0 -lgthread-2.0 -lrt -lglib-2.0 + + + + + The simplest way to compile a program is to use the "backticks" + feature of the shell. If you enclose a command in backticks + (not single quotes), then its output will be + substituted into the command line before execution: + + $ cc `pkg-config --cflags --libs tracker-miner-2.0` hello.c -o hello + + + + -- cgit v1.2.1