diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/c_glib/doc/arrow-dataset-glib | |
parent | Initial commit. (diff) | |
download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/arrow/c_glib/doc/arrow-dataset-glib')
3 files changed, 195 insertions, 0 deletions
diff --git a/src/arrow/c_glib/doc/arrow-dataset-glib/arrow-dataset-glib-docs.xml b/src/arrow/c_glib/doc/arrow-dataset-glib/arrow-dataset-glib-docs.xml new file mode 100644 index 000000000..b13195b07 --- /dev/null +++ b/src/arrow/c_glib/doc/arrow-dataset-glib/arrow-dataset-glib-docs.xml @@ -0,0 +1,88 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> + <!ENTITY % gtkdocentities SYSTEM "entities.xml"> + %gtkdocentities; +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>&package_name; Reference Manual</title> + <releaseinfo> + for &package_string;. + <!-- + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/&package_name;/">http://[SERVER]/&package_name;/</ulink>. + --> + </releaseinfo> + </bookinfo> + + <part id="data"> + <title>Data</title> + <chapter id="source"> + <title>Partitioning</title> + <xi:include href="xml/partitioning.xml"/> + <title>Dataset</title> + <xi:include href="xml/dataset.xml"/> + <title>Dataset factory</title> + <xi:include href="xml/dataset-factory.xml"/> + </chapter> + <chapter id="read"> + <title>Scan</title> + <xi:include href="xml/scanner.xml"/> + <title>Fragment</title> + <xi:include href="xml/fragment.xml"/> + <title>File format</title> + <xi:include href="xml/file-format.xml"/> + </chapter> + </part> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + <index id="deprecated-api-index" role="deprecated"> + <title>Index of deprecated API</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-6-0-0" role="6.0.0"> + <title>Index of new symbols in 6.0.0</title> + <xi:include href="xml/api-index-6.0.0.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-5-0-0" role="5.0.0"> + <title>Index of new symbols in 5.0.0</title> + <xi:include href="xml/api-index-5.0.0.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-4-0-0" role="4.0.0"> + <title>Index of new symbols in 4.0.0</title> + <xi:include href="xml/api-index-4.0.0.xml"><xi:fallback /></xi:include> + </index> + <index id="api-index-3-0-0" role="3.0.0"> + <title>Index of new symbols in 3.0.0</title> + <xi:include href="xml/api-index-3.0.0.xml"><xi:fallback /></xi:include> + </index> + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/src/arrow/c_glib/doc/arrow-dataset-glib/entities.xml.in b/src/arrow/c_glib/doc/arrow-dataset-glib/entities.xml.in new file mode 100644 index 000000000..aa5addb4e --- /dev/null +++ b/src/arrow/c_glib/doc/arrow-dataset-glib/entities.xml.in @@ -0,0 +1,24 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<!ENTITY package "@PACKAGE@"> +<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@"> +<!ENTITY package_name "@PACKAGE_NAME@"> +<!ENTITY package_string "@PACKAGE_STRING@"> +<!ENTITY package_url "@PACKAGE_URL@"> +<!ENTITY package_version "@PACKAGE_VERSION@"> diff --git a/src/arrow/c_glib/doc/arrow-dataset-glib/meson.build b/src/arrow/c_glib/doc/arrow-dataset-glib/meson.build new file mode 100644 index 000000000..ca037b7e3 --- /dev/null +++ b/src/arrow/c_glib/doc/arrow-dataset-glib/meson.build @@ -0,0 +1,83 @@ +# -*- indent-tabs-mode: nil -*- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +package_id = 'arrow-dataset-glib' +package_name = 'Apache Arrow Dataset GLib' +entities_conf = configuration_data() +entities_conf.set('PACKAGE', package_id) +entities_conf.set('PACKAGE_BUGREPORT', + 'https://issues.apache.org/jira/browse/ARROW') +entities_conf.set('PACKAGE_NAME', package_name) +entities_conf.set('PACKAGE_STRING', + ' '.join([package_id, version])) +entities_conf.set('PACKAGE_URL', 'https://arrow.apache.org/') +entities_conf.set('PACKAGE_VERSION', version) +configure_file(input: 'entities.xml.in', + output: 'entities.xml', + configuration: entities_conf) + +private_headers = [ +] + +content_files = [ +] + +html_images = [ +] + +glib_prefix = dependency('glib-2.0').get_pkgconfig_variable('prefix') +glib_doc_path = join_paths(glib_prefix, 'share', 'gtk-doc', 'html') +arrow_glib_doc_path = join_paths(data_dir, + 'gtk-doc', + 'html', + 'arrow-glib') +doc_path = join_paths(data_dir, 'gtk-doc', 'html', package_id) + +source_directories = [ + join_paths(meson.source_root(), package_id), + join_paths(meson.build_root(), package_id), +] +dependencies = [ + arrow_glib, + arrow_dataset_glib, +] +ignore_headers = [] +gnome.gtkdoc(package_id, + main_xml: package_id + '-docs.xml', + src_dir: source_directories, + dependencies: dependencies, + ignore_headers: ignore_headers, + gobject_typesfile: package_id + '.types', + scan_args: [ + '--rebuild-types', + '--deprecated-guards=GARROW_DISABLE_DEPRECATED', + ], + mkdb_args: [ + '--output-format=xml', + '--name-space=gadataset', + '--source-suffixes=c,cpp,h', + ], + fixxref_args: [ + '--html-dir=' + doc_path, + '--extra-dir=' + join_paths(glib_doc_path, 'glib'), + '--extra-dir=' + join_paths(glib_doc_path, 'gobject'), + '--extra-dir=' + arrow_glib_doc_path, + ], + html_assets: html_images, + install: true) |