Skip to content

Commit 215a1db

Browse files
authored
Feature Branch Merge -- DOC-8132; 8591; 8590; 8272; 8142 (couchbase#486)
* DOC-8132 -- C language infrastructure https://issues.couchbase.com/browse/DOC-8132 clang-prep -- interim 210628--1358 (cherry picked from commit bc1bdb379f32dff15fe5fe9607f79bf1d9dace8d) clang-prep -- INterim 210629-1153 (cherry picked from commit 3cfd3a9dbde40b400425dfc22110211bc7ba7a79) (cherry picked from commit a1a976bc6836246d130d948829d5ad053f889957) * DOC-8591 -- JSON API Methods https://issues.couchbase.com/browse/DOC-8591 DOC-8064 -- interim 210513-1 -- initial content interim 210601 DOC-8591 -- JSONAPI initialSwift code snips DOC-8591 -- jsonresults incusion DOC-8591-JSON-Methods -- homogenize objc and java doc.adoc DOC-8591 -- Blobs DOC-8591 -- Update JSON Results callouts DOC-8591-JSON-Methods -- Sperate results sets page DOC-8591 -- fix swift resultset page (cherry picked from commit c9adf9a8ce61b0395205ab57e2188fe8cf63a63b) * DOC-8590 -- JSON Results Code Snippet Changes https://issues.couchbase.com/browse/DOC-8590 DOC-8590-C3.0-Code -- Code update better deserialzation examples DOC-8590-C3.0-Code -- Code update better deserialzation examples DOC-8590 -- JSON Results Code Snippet Changes https://issues.couchbase.com/browse/DOC-8590 DOC-8590-C3.0-Code -- include iOS feedback DOC-8590-C3.0-Code -- Update C# for Json results DOC-8590-C3.0-Code -- Code update better deserialzation examples (cherry picked from commit cdfa8fb) * DOC-8272 -- N1QL Query Interim 210601-1430 DOC-8272-N1QL -- Interim CLANG pages DOC-8272-N1QL -- Interim 210615 DOC-8272-NQL -- run DOC-8272-N1QL -- Select DOC-8272-N1QL -- Commonize results set page DOC-8272-N1QL -- Interim 210729 (cherry picked from commit 66c5680615f60f20dd0d34a72c6211ec81f4f4d0) * stage300 -- regress n1QL use of block_show_snippet * DOC-8142 -- KOtlin Infrastructure changes https://issues.couchbase.com/browse/DOC-8142 DOC-8142 -- Kotlin Insfrastructure Changes INITIAL DOC-8142 -- Kotlin Interim 210730 DOC-8142 -- Kotlin Interim 210730-1044 DOC-8142 -- Kotlin Interim 210803-1643 DOC-8142 -- Kotlin Interim 210803-1656 DOC-8142 -- Kotlin Interim 210803-1800 (cherry picked from commit 91fb33a9a6328cbb8c82f59172378ab69814085e)
1 parent bbec4dc commit 215a1db

File tree

214 files changed

+15950
-1786
lines changed

Some content is hidden

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

214 files changed

+15950
-1786
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,4 @@ modules/swift/examples/CouchbaseLiteSwift.xcframework/**
103103
modules/android/examples/docsnippets/**
104104
modules/android/examples/jsonsnippets/**
105105

106+
tempbin/SampeCodeTest_extract270721.swift

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ start_page: couchbase-lite:ROOT:index.adoc
55
nav:
66
- modules/ROOT/nav.adoc
77
- modules/android/nav-android.adoc
8-
- modules/csharp/nav-csharp.adoc
98
- modules/clang/nav-clang.adoc
9+
- modules/csharp/nav-csharp.adoc
1010
- modules/java/nav-java.adoc
1111
- modules/objc/nav-objc.adoc
1212
- modules/swift/nav-swift.adoc

modules/ROOT/.DS_Store

0 Bytes
Binary file not shown.

modules/ROOT/pages/_partials/_attributes-local.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ endif::[]
194194
:url-tutorial-mobile-workshop: {url-tutorials}mobile-travel-sample/introduction.html[Couchbase Mobile Workshop]
195195

196196

197+
:url-n1ql-tutorial: https://query-tutorial.couchbase.com/tutorial/#1[N1QL Tutorials]
197198

198199
// END URLs
199200

@@ -274,7 +275,7 @@ ifdef::is-android[]
274275
:securestorage-api: KeyStore API
275276
endif::[]
276277

277-
ifeval::["{param-platform}"=="{platform-ios}"]
278+
ifdef::is-ios[]
278279
:securestorage: Keychain
279280
:securestorage-api: Keychain API
280281
endif::[]
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// BEGIN inclusion -- block -- _block_show_snippets.adoc
2+
//
3+
// Allows for abstraction of the showing of snippet examples
4+
// which makes displaying tabbed snippets for platforms with
5+
// more than one native language to show -- Android (Kotlin and Java)
6+
//
7+
// PARAMETERS:
8+
// param-tags comma-separated list of tags to include/exclude
9+
//
10+
// USE:
11+
// :param_tags: query-access-json
12+
// include::partial$_block_show_snippet.adoc[]
13+
// :param_tags!:
14+
//
15+
:self-tags:
16+
ifdef::is-android[:is-tabbed:]
17+
ifdef::param-tags[:self-tags: {param-tags}]
18+
ifdef::is-tabbed[]
19+
// inject tab header
20+
[{tabs}]
21+
======
22+
23+
{source-language}::
24+
+
25+
--
26+
endif::is-tabbed[]
27+
28+
// Show Main Snippet
29+
[source, {source-language}]
30+
----
31+
include::{snippet}[tags="{self-tags}", indent=0]
32+
----
33+
34+
ifdef::is-tabbed[]
35+
--
36+
// Show Optional Alternate Snippet
37+
{source-language-alt}::
38+
+
39+
--
40+
[source, {source-language-alt}]
41+
----
42+
include::{snippet-alt}[tags="{self-tags}", indent=0]
43+
----
44+
// Add tab closure
45+
--
46+
47+
======
48+
endif::is-tabbed[]
49+
50+
51+
// Tidy-up atttibutes created
52+
:self_tags!:
53+
:is-tabbed!:
54+
// END -- _block_show_snippet.doc
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
// BEGIN inclusion -- block -- _block_tabbed_code_block.adoc
2+
//
3+
// Allows for abstraction of the showing of snippet examples
4+
// which makes displaying tabbed snippets for platforms with
5+
// more than one native language to show -- Android (Kotlin and Java)
6+
//
7+
// This version does not add an example block
8+
//
9+
// PARAMETERS:
10+
// param-tags comma-separated list of tags to include/exclude
11+
//
12+
// USE:
13+
// :param_tags: query-access-json
14+
// include::partial$_block_show_snippet.adoc[]
15+
// :param_tags!:
16+
//
17+
:self-tags:
18+
ifdef::is-android[:is-tabbed:]
19+
ifdef::param-tags[:self-tags: {param-tags}]
20+
21+
ifdef::is-tabbed[]
22+
23+
// inject tab header
24+
[{tabs}]
25+
=====
26+
27+
{source-language}::
28+
+
29+
--
30+
endif::is-tabbed[]
31+
32+
// Show Main Snippet
33+
[source, {source-language}]
34+
----
35+
include::{snippet}[tags="{self-tags}", indent=0]
36+
----
37+
38+
ifdef::is-tabbed[]
39+
--
40+
// Show Optional Alternate Snippet
41+
{source-language-alt}::
42+
+
43+
--
44+
[source, {source-language-alt}]
45+
----
46+
include::{snippet-alt}[tags="{self-tags}", indent=0]
47+
----
48+
// Add tab closure
49+
--
50+
51+
=====
52+
endif::is-tabbed[]
53+
54+
55+
ifdef::param-callouts[{param-callouts}]
56+
57+
58+
// Tidy-up attributes created
59+
:self_tags!:
60+
:is-tabbed!:
61+
// END -- _block_tabbed_code_block.adoc
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
// BEGIN inclusion -- block -- _block_tabbed_code_example.adoc
2+
//
3+
// Allows for abstraction of the showing of snippet examples
4+
// which makes displaying tabbed snippets for platforms with
5+
// more than one native language to show -- Android (Kotlin and Java)
6+
//
7+
// Surrounds code in Example block
8+
//
9+
// PARAMETERS:
10+
// param-tags comma-separated list of tags to include/exclude
11+
// param-leader text for opening para of an example block
12+
//
13+
// USE:
14+
// :param_tags: query-access-json
15+
// include::partial$_block_show_snippet.adoc[]
16+
// :param_tags!:
17+
//
18+
:self-tags:
19+
ifdef::is-android[:is-tabbed:]
20+
ifdef::param-tags[:self-tags: {param-tags}]
21+
22+
====
23+
24+
ifdef::param-leader[{param-leader}]
25+
ifdef::is-tabbed[]
26+
// inject tab header
27+
[{tabs}]
28+
=====
29+
30+
{source-language}::
31+
+
32+
--
33+
endif::is-tabbed[]
34+
35+
// Show Main Snippet
36+
[source, {source-language}]
37+
----
38+
include::{snippet}[tags="{self-tags}", indent=0]
39+
----
40+
41+
ifdef::is-tabbed[]
42+
--
43+
// Show Optional Alternate Snippet
44+
{source-language-alt}::
45+
+
46+
--
47+
[source, {source-language-alt}]
48+
----
49+
include::{snippet-alt}[tags="{self-tags}", indent=0]
50+
----
51+
// Add tab closure
52+
--
53+
54+
=====
55+
endif::is-tabbed[]
56+
57+
58+
ifdef::param-callouts[{param-callouts}]
59+
60+
// close example block
61+
62+
====
63+
64+
// Tidy-up atttibutes created
65+
:self_tags!:
66+
:is-tabbed!:
67+
// END -- _block_show_snippet.doc

modules/ROOT/pages/_partials/_page-index.adoc

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,25 @@ ifndef::version[:version: version undefined]
2020
:cbl--xref: xref:couchbase-lite:{param-module}:
2121
:cbl-root--pfx: xref:couchbase-lite::
2222
:sgw--xref: xref:sync-gateway::
23+
:svr--xref: xref:server:
2324

2425
:xref-pfx-cbl: {cbl--xref}
2526
:xref-pfx-sgw: {sgw--xref}
2627
:xref-pfx-root: {cbl-root--pfx}
2728
// End -- define module context
2829

30+
// BEGIN -- Couchbase Server XREFS
31+
32+
:svr--xref: xref:server:
33+
34+
:svr-n1ql-datamodel--xref: {svr--xref}learn:data/n1ql-versus-sql.adoc[N1QL Data Model]
35+
// https://docs.couchbase.com/server/current/learn/data/n1ql-versus-sql.html[]
36+
:svr-n1ql-reference--xref: {svr--xref}n1ql:n1ql-language-reference/index.adoc[N1QL Reference Guide]
37+
38+
// END -- Couchbase Server XREFS
39+
40+
41+
2942

3043
:xref-cbl-pg-tutorial-p2psync: xref:tutorials:cbl-p2p-sync-websockets:swift/cbl-p2p-sync-websockets.adoc[Getting Started with Peer-to-Peer Synchronization]
3144

@@ -87,13 +100,19 @@ ifndef::version[:version: version undefined]
87100
:p2psync-websocket--page: p2psync-websocket.adoc
88101
:p2psync-websocket--xref: {cbl--xref}{p2psync-websocket--page}[P2Psync Websocket]
89102
:p2psync-websocket-using-active--page: p2psync-websocket-using-active.adoc
90-
:p2psync-websocket-using-active--xref: {cbl--xref}{p2psync-websocket-using-active--page}[P2Psync Websocket Using Active]
103+
:p2psync-websocket-using-active--pfx: {cbl--xref}{p2psync-websocket-using-active--page}
104+
:p2psync-websocket-using-active--xref: {p2psync-websocket-using-active--pfx}[Using Active Peer]
105+
:p2psync-websocket-using-active--authenticate-listener: {p2psync-websocket-using-active--pfx}#authenticate-listener[Authenticate Listener on Active Peer]
106+
91107
:p2psync-websocket-using-passive--page: p2psync-websocket-using-passive.adoc
92-
:p2psync-websocket-using-passive--xref: {cbl--xref}{p2psync-websocket-using-passive--page}[P2Psync Websocket Using Passive]
108+
:p2psync-websocket-using-passive--pfx: {cbl--xref}{p2psync-websocket-using-passive--page}
109+
:p2psync-websocket-using-passive--xref: {p2psync-websocket-using-passive--pfx}[Using Passive Peer]
93110
:prebuilt-database--page: prebuilt-database.adoc
94111
:prebuilt-database--xref: {cbl--xref}{prebuilt-database--page}[Prebuilt Database]
95112
:querybuilder--page: querybuilder.adoc
96113
:querybuilder--xref: {cbl--xref}{querybuilder--page}[QueryBuilder]
114+
:querybuilder-n1ql--page: querybuilder-n1ql.adoc
115+
:querybuilder-n1ql--xref: {cbl--xref}{querybuilder-n1ql--page}[N1QL Queries]
97116
:query-live--page: query-live.adoc
98117
:query-live--xref: {cbl--xref}{query-live--page}[Query Live]
99118
:query-predictive--page: query-predictive.adoc
@@ -184,12 +203,10 @@ ifndef::version[:version: version undefined]
184203
// Being -- Ref - xrefs
185204
//
186205
:xref-cbl-pfx-database: {cbl--xref}{cbl-pg-database}
187-
:xref-cbl-pfx-dbo-p2psync-websocket-using-active: {cbl--xref}{cbl-pg-dbo-p2psync-websocket-using-active}
188206
:xref-cbl-pfx-p2psync-websocket: {cbl--xref}{cbl-pg-p2psync-websocket}
189207
:xref-cbl-pfx-replication: {cbl--xref}{replication--page}
190208

191209
:xref-cbl-bmk-database-findfile: {xref-cbl-pfx-database}#lbl-find-db-loc[Finding a Database File]
192-
:xref-cbl-bmk-dbo-p2psync-websocket-using-active-auth-listener: {xref-cbl-pfx-dbo-p2psync-websocket-using-active}#authenticating-the-listener[Active Peer - authenticating the listener]
193210
:xref-cbl-bmk-replication-deltasync: {xref-cbl-pfx-replication}#delta-sync[Delta-Sync Replications]
194211
:xref-cbl-pg-blob: {cbl--xref}{cbl-pg-blob}[Blobs]
195212
:xref-cbl-pg-build: {cbl--xref}{cbl-pg-build}[Build and Run]
@@ -207,7 +224,6 @@ ifndef::version[:version: version undefined]
207224
:xref-cbl-pg-date-time: {cbl--xref}{cbl-pg-date-time}[Date and Time Functions]
208225
:xref-cbl-pg-dbo-crud: {cbl--xref}{cbl-pg-dbo-crud}[Using CRUD Operations]
209226
:xref-cbl-pg-dbo-p2psync-cloud-using: {cbl--xref}{cbl-pg-dbo-p2psync-cloud-using}[Peer-to-Peer Synchronization (cloud)]
210-
:xref-cbl-pg-dbo-p2psync-websocket-using-active: {xref-cbl-pfx-dbo-p2psync-websocket-using-active}[Active Peer]
211227
:xref-cbl-pg-dbo-p2psync-websocket-using-passive--delta-sync: {cbl--xref}{cbl-pg-dbo-p2psync-websocket-using-passive--delta-sync}[Delta Sync]
212228
:xref-cbl-pg-dbo-p2psync-websocket-using-passive: {cbl--xref}{cbl-pg-dbo-p2psync-websocket-using-passive}[Passive Peer]
213229
:xref-cbl-pg-dbo-query: {cbl--xref}{cbl-pg-dbo-query}[Using Query Operations]

modules/ROOT/pages/_partials/_related-content.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Blog Entries
8585

8686
// tag::how-p2psync[]
8787
* {xref-cbl-pg-dbo-p2psync-websocket-using-passive}
88-
* {xref-cbl-pg-dbo-p2psync-websocket-using-active}
88+
* {p2psync-websocket-using-active--xref}
8989
// * {xref-cbl-pg-p2p-manage-tls-id}
9090
// end::how-p2psync[]
9191

modules/ROOT/pages/_partials/_set-platform.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,17 @@ ifeval::["{page-module}"=="{lang-mod-android}"]
99
:is-android:
1010
endif::[]
1111

12+
ifeval::["{page-module}"=="{lang-mod-clang}"]
13+
:is-clang:
14+
endif::[]
15+
1216
ifeval::["{page-module}"=="{lang-mod-java}"]
1317
:is-java:
1418
endif::[]
1519

1620
ifeval::["{page-module}"=="{lang-mod-csharp}"]
1721
:is-csharp:
22+
:is-net:
1823
endif::[]
1924

2025
ifeval::["{page-module}"=="{lang-mod-objc}"]

0 commit comments

Comments
 (0)