Skip to content

Commit 4de0874

Browse files
koukou
authored
GH-39935: [GLib][Docs] Use GI-DocGen instead of GTK-Doc (#40427)
### Rationale for this change DI-DocGen is a new documentation generator for GObject-based libraries. GTK-Doc is still maintained but abandoned. ### What changes are included in this PR? Use GI-DocGen. ### Are these changes tested? Yes. ### Are there any user-facing changes? Yes. * GitHub Issue: #39935 Authored-by: Sutou Kouhei <[email protected]> Signed-off-by: Sutou Kouhei <[email protected]>
1 parent 6a7a6ee commit 4de0874

File tree

75 files changed

+712
-1565
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+712
-1565
lines changed

‎c_glib/Brewfile‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,5 @@
1616
# under the License.
1717

1818
brew "gobject-introspection"
19-
brew "gtk-doc"
20-
brew "libtool"
2119
brew "meson"
2220
brew "vala"

‎c_glib/arrow-cuda-glib/meson.build‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,13 @@ if have_gi
7272
dependencies: gir_dependencies,
7373
export_packages: 'arrow-cuda-glib',
7474
extra_args: gir_extra_args,
75-
fatal_warnings: gi_fatal_warnings,
7675
header: 'arrow-cuda-glib/arrow-cuda-glib.h',
7776
identifier_prefix: 'GArrowCUDA',
7877
includes: [
7978
'Arrow-1.0',
8079
],
81-
install: true,
80+
kwargs: generate_gi_common_args,
8281
namespace: 'ArrowCUDA',
83-
nsversion: api_version,
8482
sources: sources + c_headers,
8583
symbol_prefix: 'garrow_cuda')
8684

‎c_glib/arrow-dataset-glib/meson.build‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,23 +88,21 @@ pkgconfig.generate(libarrow_dataset_glib,
8888
version: version)
8989

9090
if have_gi
91-
dataset_glib_gir = \
91+
arrow_dataset_glib_gir = \
9292
gnome.generate_gir(libarrow_dataset_glib,
9393
dependencies: declare_dependency(sources: arrow_glib_gir),
9494
export_packages: 'arrow-dataset-glib',
9595
extra_args: [
9696
'--warn-all',
9797
'--include-uninstalled=./arrow-glib/Arrow-1.0.gir',
9898
],
99-
fatal_warnings: gi_fatal_warnings,
10099
header: 'arrow-dataset-glib/arrow-dataset-glib.h',
101100
identifier_prefix: 'GADataset',
102101
includes: [
103102
'Arrow-1.0',
104103
],
105-
install: true,
104+
kwargs: generate_gi_common_args,
106105
namespace: 'ArrowDataset',
107-
nsversion: api_version,
108106
sources: sources + c_headers + enums,
109107
symbol_prefix: 'gadataset')
110108

@@ -115,6 +113,6 @@ if have_gi
115113
arrow_glib_vapi,
116114
'gio-2.0',
117115
],
118-
sources: [dataset_glib_gir[0]])
116+
sources: [arrow_dataset_glib_gir[0]])
119117
endif
120118
endif

‎c_glib/arrow-flight-glib/meson.build‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,34 +65,32 @@ pkgconfig.generate(libarrow_flight_glib,
6565
version: version)
6666

6767
if have_gi
68-
flight_glib_gir = \
68+
arrow_flight_glib_gir = \
6969
gnome.generate_gir(libarrow_flight_glib,
7070
dependencies: declare_dependency(sources: arrow_glib_gir),
7171
export_packages: 'arrow-flight-glib',
7272
extra_args: [
7373
'--warn-all',
7474
'--include-uninstalled=./arrow-glib/Arrow-1.0.gir',
7575
],
76-
fatal_warnings: gi_fatal_warnings,
7776
header: 'arrow-flight-glib/arrow-flight-glib.h',
7877
identifier_prefix: 'GAFlight',
7978
includes: [
8079
'Arrow-1.0',
8180
],
82-
install: true,
81+
kwargs: generate_gi_common_args,
8382
namespace: 'ArrowFlight',
84-
nsversion: api_version,
8583
sources: sources + c_headers,
8684
symbol_prefix: 'gaflight')
8785

8886
if generate_vapi
89-
flight_glib_vapi = \
87+
arrow_flight_glib_vapi = \
9088
gnome.generate_vapi('arrow-flight-glib',
9189
install: true,
9290
packages: [
9391
arrow_glib_vapi,
9492
'gio-2.0',
9593
],
96-
sources: [flight_glib_gir[0]])
94+
sources: [arrow_flight_glib_gir[0]])
9795
endif
9896
endif

‎c_glib/arrow-flight-sql-glib/meson.build‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,38 +63,36 @@ pkgconfig.generate(libarrow_flight_sql_glib,
6363
version: version)
6464

6565
if have_gi
66-
flight_sql_glib_gir_dependencies = \
67-
declare_dependency(sources: [arrow_glib_gir, flight_glib_gir])
68-
flight_sql_glib_gir = \
66+
arrow_flight_sql_glib_gir_dependencies = \
67+
declare_dependency(sources: [arrow_glib_gir, arrow_flight_glib_gir])
68+
arrow_flight_sql_glib_gir = \
6969
gnome.generate_gir(libarrow_flight_sql_glib,
70-
dependencies: flight_sql_glib_gir_dependencies,
70+
dependencies: arrow_flight_sql_glib_gir_dependencies,
7171
export_packages: 'arrow-flight-sql-glib',
7272
extra_args: [
7373
'--warn-all',
7474
'--include-uninstalled=./arrow-glib/Arrow-1.0.gir',
7575
'--include-uninstalled=./arrow-flight-glib/ArrowFlight-1.0.gir',
7676
],
77-
fatal_warnings: gi_fatal_warnings,
7877
header: 'arrow-flight-sql-glib/arrow-flight-sql-glib.h',
7978
identifier_prefix: 'GAFlightSQL',
8079
includes: [
8180
'Arrow-1.0',
8281
'ArrowFlight-1.0',
8382
],
84-
install: true,
83+
kwargs: generate_gi_common_args,
8584
namespace: 'ArrowFlightSQL',
86-
nsversion: api_version,
8785
sources: sources + c_headers,
8886
symbol_prefix: 'gaflightsql')
8987

9088
if generate_vapi
9189
gnome.generate_vapi('arrow-flight-sql-glib',
9290
install: true,
9391
packages: [
94-
flight_glib_vapi,
92+
arrow_flight_glib_vapi,
9593
arrow_glib_vapi,
9694
'gio-2.0',
9795
],
98-
sources: [flight_sql_glib_gir[0]])
96+
sources: [arrow_flight_sql_glib_gir[0]])
9997
endif
10098
endif

‎c_glib/arrow-glib/meson.build‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -279,18 +279,16 @@ if have_gi
279279
extra_args: [
280280
'--warn-all',
281281
],
282-
fatal_warnings: gi_fatal_warnings,
283282
header: 'arrow-glib/arrow-glib.h',
284283
identifier_prefix: 'GArrow',
285284
includes: [
286285
'GObject-2.0',
287286
'Gio-2.0',
288287
],
289-
install: true,
290288
namespace: 'Arrow',
291-
nsversion: api_version,
292289
sources: sources + c_headers + enums,
293-
symbol_prefix: 'garrow')
290+
symbol_prefix: 'garrow',
291+
kwargs: generate_gi_common_args)
294292

295293
if generate_vapi
296294
arrow_glib_vapi = gnome.generate_vapi('arrow-glib',

‎c_glib/doc/arrow-cuda-glib.toml.in‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
[library]
19+
name = "Apache Arrow CUDA GLib"
20+
version = "@VERSION@"
21+
browse_url = "https://github.com/apache/arrow/tree/@SOURCE_REFERENCE@/c_glib/arrow-cuda-glib/"
22+
repository_url = "https://github.com/apache/arrow.git"
23+
website_url = "https://arrow.apache.org/docs/c_glib/arrow-cuda-glib/"
24+
authors = "The Apache Software Foundation"
25+
license = "Apache-2.0"
26+
description = "Apache Arrow CUDA GLib API"
27+
dependencies = ["Arrow-1.0"]
28+
related = ["Gio-2.0", "GObject-2.0"]
29+
search_index = true
30+
31+
[dependencies."Arrow-1.0"]
32+
name = "Arrow"
33+
description = "Apache Arrow GLib API"
34+
docs_url = "https://arrow.apache.org/docs/c_glib/arrow-glib/"
35+
36+
[related."Gio-2.0"]
37+
name = "GIO"
38+
description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
39+
docs_url = "https://docs.gtk.org/gio/"
40+
41+
[related."GObject-2.0"]
42+
name = "GObject"
43+
description = "The base type system library"
44+
docs_url = "https://docs.gtk.org/gobject/"
45+
46+
[source-location]
47+
base_url = "https://github.com/apache/arrow/blob/@SOURCE_REFERENCE@/c_glib/arrow-cuda-glib"
48+
49+
[extra]
50+
content_base_url = "https://github.com/apache/arrow/blob/@SOURCE_REFERENCE@/c_glib/doc/"
51+
content_files = [
52+
]
53+
content_images = [
54+
]
55+
urlmap_file = "urlmap.js"

‎c_glib/doc/arrow-dataset-glib.toml.in‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
[library]
19+
name = "Apache Arrow Dataset GLib"
20+
version = "@VERSION@"
21+
browse_url = "https://github.com/apache/arrow/tree/@SOURCE_REFERENCE@/c_glib/arrow-dataset-glib/"
22+
repository_url = "https://github.com/apache/arrow.git"
23+
website_url = "https://arrow.apache.org/docs/c_glib/arrow-dataset-glib/"
24+
authors = "The Apache Software Foundation"
25+
license = "Apache-2.0"
26+
description = "Apache Arrow Dataset GLib API"
27+
dependencies = ["Arrow-1.0"]
28+
related = ["Gio-2.0", "GObject-2.0"]
29+
search_index = true
30+
31+
[dependencies."Arrow-1.0"]
32+
name = "Arrow"
33+
description = "Apache Arrow GLib API"
34+
docs_url = "https://arrow.apache.org/docs/c_glib/arrow-glib/"
35+
36+
[related."Gio-2.0"]
37+
name = "GIO"
38+
description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
39+
docs_url = "https://docs.gtk.org/gio/"
40+
41+
[related."GObject-2.0"]
42+
name = "GObject"
43+
description = "The base type system library"
44+
docs_url = "https://docs.gtk.org/gobject/"
45+
46+
[source-location]
47+
base_url = "https://github.com/apache/arrow/blob/@SOURCE_REFERENCE@/c_glib/arrow-dataset-glib"
48+
49+
[extra]
50+
content_base_url = "https://github.com/apache/arrow/blob/@SOURCE_REFERENCE@/c_glib/doc/"
51+
content_files = [
52+
]
53+
content_images = [
54+
]
55+
urlmap_file = "urlmap.js"

‎c_glib/doc/arrow-dataset-glib/arrow-dataset-glib-docs.xml‎

Lines changed: 0 additions & 92 deletions
This file was deleted.

‎c_glib/doc/arrow-dataset-glib/entities.xml.in‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)