Skip to content

Commit 4de2b78

Browse files
mewimmewim
authored
Merge pull request #1 from kuzudb/api-documentation-update-2eca6574670fedbb2ec27e627a2f2bc302bf0dae
Update API documentations
2 parents 2e47cf9 + 23d8a3c commit 4de2b78

File tree

1,029 files changed

+34063
-17484
lines changed

Some content is hidden

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

1,029 files changed

+34063
-17484
lines changed

‎c/annotated.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: Data Structures</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -114,7 +114,7 @@
114114
</div><!-- contents -->
115115
<!-- start footer part -->
116116
<hr class="footer"/><address class="footer"><small>
117-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
117+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
118118
</small></address>
119119
</div><!-- doc-content -->
120120
</body>

‎c/classes.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: Data Structure Index</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -99,7 +99,7 @@
9999
</div><!-- contents -->
100100
<!-- start footer part -->
101101
<hr class="footer"/><address class="footer"><small>
102-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
102+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
103103
</small></address>
104104
</div><!-- doc-content -->
105105
</body>

‎c/clipboard.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ SOFTWARE.
2828
*/
2929

3030
let clipboard_title = "Copy to clipboard"
31-
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
32-
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
31+
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill="#888" d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
32+
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
3333
let clipboard_successDuration = 1000
3434

3535
$(function() {

‎c/doxygen.css

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* The standard CSS for doxygen 1.12.0*/
1+
/* The standard CSS for doxygen 1.13.2*/
22

33
html {
44
/* page base colors */
@@ -726,8 +726,7 @@ pre.fragment {
726726
opacity: 0;
727727
position: absolute;
728728
display: inline;
729-
overflow: auto;
730-
fill: var(--fragment-foreground-color);
729+
overflow: hidden;
731730
justify-content: center;
732731
align-items: center;
733732
cursor: pointer;
@@ -739,7 +738,7 @@ pre.fragment {
739738
}
740739

741740
.fragment:hover .clipboard, .clipboard.success {
742-
opacity: .28;
741+
opacity: .4;
743742
}
744743

745744
.clipboard:hover, .clipboard.success {
@@ -1810,6 +1809,11 @@ dl.invariant dt, dl.pre dt, dl.post dt {
18101809
padding: 2px 0px;
18111810
}
18121811

1812+
#side-nav #projectname
1813+
{
1814+
font-size: 130%;
1815+
}
1816+
18131817
#projectbrief
18141818
{
18151819
font-size: 90%;
@@ -2197,10 +2201,14 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter {
21972201
text-align: center
21982202
}
21992203

2200-
tt, code, kbd, samp
2204+
tt, code, kbd
22012205
{
22022206
display: inline-block;
22032207
}
2208+
tt, code, kbd
2209+
{
2210+
vertical-align: top;
2211+
}
22042212
/* @end */
22052213

22062214
u {

‎c/doxygen_crawl.html

Lines changed: 4 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -4,78 +4,13 @@
44
<title>Validator / crawler helper</title>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
7-
<meta name="generator" content="Doxygen 1.12.0"/>
7+
<meta name="generator" content="Doxygen 1.13.2"/>
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
</head>
1010
<body>
11-
<a href="kuzu_8h_source.html"/>
12-
<a href="kuzu_8h.html"/>
13-
<a href="struct_arrow_array.html"/>
14-
<a href="struct_arrow_schema.html"/>
15-
<a href="structkuzu__connection.html"/>
16-
<a href="structkuzu__database.html"/>
17-
<a href="structkuzu__date__t.html"/>
18-
<a href="structkuzu__flat__tuple.html"/>
19-
<a href="structkuzu__int128__t.html"/>
20-
<a href="structkuzu__internal__id__t.html"/>
21-
<a href="structkuzu__interval__t.html"/>
22-
<a href="structkuzu__logical__type.html"/>
23-
<a href="structkuzu__prepared__statement.html"/>
24-
<a href="structkuzu__query__result.html"/>
25-
<a href="structkuzu__query__summary.html"/>
26-
<a href="structkuzu__system__config.html"/>
27-
<a href="structkuzu__timestamp__ms__t.html"/>
28-
<a href="structkuzu__timestamp__ns__t.html"/>
29-
<a href="structkuzu__timestamp__sec__t.html"/>
30-
<a href="structkuzu__timestamp__t.html"/>
31-
<a href="structkuzu__timestamp__tz__t.html"/>
32-
<a href="structkuzu__value.html"/>
33-
<a href="index.html"/>
34-
<a href="doxygen_crawl.html"/>
35-
<a href="annotated.html"/>
36-
<a href="classes.html"/>
37-
<a href="functions.html"/>
38-
<a href="functions.html"/>
39-
<a href="functions.html"/>
40-
<a href="functions.html"/>
41-
<a href="functions.html"/>
42-
<a href="functions.html"/>
43-
<a href="functions.html"/>
44-
<a href="functions.html"/>
45-
<a href="functions.html"/>
46-
<a href="functions.html"/>
47-
<a href="functions.html"/>
48-
<a href="functions.html"/>
49-
<a href="functions.html"/>
50-
<a href="functions.html"/>
51-
<a href="functions.html"/>
52-
<a href="functions.html"/>
53-
<a href="functions_vars.html"/>
54-
<a href="functions_vars.html"/>
55-
<a href="functions_vars.html"/>
56-
<a href="functions_vars.html"/>
57-
<a href="functions_vars.html"/>
58-
<a href="functions_vars.html"/>
59-
<a href="functions_vars.html"/>
60-
<a href="functions_vars.html"/>
61-
<a href="functions_vars.html"/>
62-
<a href="functions_vars.html"/>
63-
<a href="functions_vars.html"/>
64-
<a href="functions_vars.html"/>
65-
<a href="functions_vars.html"/>
66-
<a href="functions_vars.html"/>
67-
<a href="functions_vars.html"/>
68-
<a href="functions_vars.html"/>
69-
<a href="files.html"/>
70-
<a href="globals.html"/>
71-
<a href="globals_k.html"/>
72-
<a href="globals_func.html"/>
73-
<a href="globals_enum.html"/>
74-
<a href="globals_eval.html"/>
75-
<a href="globals_defs.html"/>
76-
<a href="globals_defs.html"/>
7711
<a href="annotated.html"/>
7812
<a href="classes.html"/>
13+
<a href="doxygen_crawl.html"/>
7914
<a href="files.html"/>
8015
<a href="functions.html"/>
8116
<a href="functions_vars.html"/>
@@ -85,6 +20,7 @@
8520
<a href="globals_eval.html"/>
8621
<a href="globals_func.html"/>
8722
<a href="globals_k.html"/>
23+
<a href="index.html"/>
8824
<a href="kuzu_8h.html"/>
8925
<a href="kuzu_8h.html#a00f398f84b01b1dbd6c7486379edc017"/>
9026
<a href="kuzu_8h.html#a0185f0fff5395fbca574c87479e9b360"/>
@@ -303,6 +239,7 @@
303239
<a href="kuzu_8h.html#afbef1cd9b409d32052c8df430b8bd7c4"/>
304240
<a href="kuzu_8h.html#afdb25cacefea8e065012430df50a257c"/>
305241
<a href="kuzu_8h.html#afe2987fe02e5ab238154f16e0b3aa82f"/>
242+
<a href="kuzu_8h_source.html"/>
306243
<a href="struct_arrow_array.html"/>
307244
<a href="struct_arrow_array.html#a03ad36422f651c0b0ccd9ab9c5b7d5d3"/>
308245
<a href="struct_arrow_array.html#a1f2d5a334bb41924c4822bbfc7aec63e"/>

‎c/files.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: File List</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -95,7 +95,7 @@
9595
</div><!-- contents -->
9696
<!-- start footer part -->
9797
<hr class="footer"/><address class="footer"><small>
98-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
98+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
9999
</small></address>
100100
</div><!-- doc-content -->
101101
</body>

‎c/functions.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: Data Fields</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -189,7 +189,7 @@ <h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
189189
</div><!-- contents -->
190190
<!-- start footer part -->
191191
<hr class="footer"/><address class="footer"><small>
192-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
192+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
193193
</small></address>
194194
</div><!-- doc-content -->
195195
</body>

‎c/functions_vars.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: Data Fields - Variables</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -189,7 +189,7 @@ <h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
189189
</div><!-- contents -->
190190
<!-- start footer part -->
191191
<hr class="footer"/><address class="footer"><small>
192-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
192+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
193193
</small></address>
194194
</div><!-- doc-content -->
195195
</body>

‎c/globals.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: Globals</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -95,7 +95,7 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
9595
</div><!-- contents -->
9696
<!-- start footer part -->
9797
<hr class="footer"/><address class="footer"><small>
98-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
98+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
9999
</small></address>
100100
</div><!-- doc-content -->
101101
</body>

‎c/globals_defs.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.12.0"/>
6+
<meta name="generator" content="Doxygen 1.13.2"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Kùzu C API: Globals</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -33,7 +33,7 @@
3333
</table>
3434
</div>
3535
<!-- end header part -->
36-
<!-- Generated by Doxygen 1.12.0 -->
36+
<!-- Generated by Doxygen 1.13.2 -->
3737
<script type="text/javascript">
3838
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
3939
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -101,7 +101,7 @@
101101
</div><!-- contents -->
102102
<!-- start footer part -->
103103
<hr class="footer"/><address class="footer"><small>
104-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
104+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
105105
</small></address>
106106
</div><!-- doc-content -->
107107
</body>

0 commit comments

Comments
 (0)