Skip to content

Commit 1b8c493

Browse files
authored
DOC-8131 -- C Productization -- Prepare asciidoc module (#416)
https://issues.couchbase.com/browse/DOC-8131
1 parent 7d0e78e commit 1b8c493

Some content is hidden

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

54 files changed

+3854
-2
lines changed

antora.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ start_page: couchbase-lite:ROOT:index.adoc
55
nav:
66
- modules/ROOT/nav.adoc
77
- modules/android/nav-android.adoc
8+
- modules/clang/nav-clang.adoc
89
- modules/csharp/nav-csharp.adoc
910
- modules/java/nav-java.adoc
1011
- modules/objc/nav-objc.adoc
Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Query: include::{snippet}
2+
# Flags: IgnoreExcludeSettings
3+
# Including: ./cbl/modules/ROOT
4+
# ContextLines: 1
5+
6+
1x-attachment
7+
active-peer-close
8+
active-peer-open
9+
active-peer-receive
10+
active-peer-send
11+
active-replicator-close
12+
add-document-replication-listener
13+
advertizer-accept
14+
basic-authentication
15+
batch
16+
blob
17+
certificate-pinning
18+
console-logging
19+
coreml-predictive-model
20+
create-connection
21+
custom-logging
22+
database-encryption
23+
database-replica
24+
date-getter
25+
document-expiration
26+
document-listener
27+
file-logging
28+
fts-index
29+
fts-query
30+
getting-started
31+
initializer
32+
listener
33+
listener-config-client-auth-pwd-full
34+
listener-config-delete-cert-full
35+
live-query
36+
local-win-conflict-resolver
37+
logging
38+
merge-conflict-resolver
39+
message-endpoint
40+
message-endpoint-replicator
41+
new-database
42+
p2psync-act-tlsid-create
43+
p2psync-act-tlsid-delete
44+
p2psync-act-tlsid-import
45+
passive-peer-close
46+
passive-peer-open
47+
passive-peer-receive
48+
passive-peer-send
49+
passive-replicator-close
50+
passive-stop-listener
51+
prebuilt-database
52+
predictive-model
53+
predictive-query
54+
predictive-query-predictive-index
55+
predictive-query-value-index
56+
query-collection-operator-contains
57+
query-collection-operator-in
58+
query-deleted-documents
59+
query-explain-all
60+
query-explain-function
61+
query-explain-like
62+
query-explain-nofunction
63+
query-explain-nopfx
64+
query-groupby
65+
query-index
66+
query-join
67+
query-like-operator
68+
query-like-operator-wildcard-character-match
69+
query-like-operator-wildcard-match
70+
query-orderby
71+
query-regex-operator
72+
query-select-all
73+
query-select-meta
74+
query-where
75+
register-model
76+
remote-win-conflict-resolver
77+
remove-document-replication-listener
78+
replication-conflict-resolver
79+
replication-custom-header
80+
replication-error-handling
81+
replication-logging
82+
replication-pendingdocuments
83+
replication-pull-filter
84+
replication-push-filter
85+
replication-reset-checkpoint
86+
replication-set-heartbeat
87+
replication-status
88+
sdk-initializer
89+
session-authentication
90+
set-custom-logging
91+
stop-live-query
92+
to-dictionary
93+
unregister-model
94+
update-document
95+
update-document-with-conflict-handler
96+
update-document-with-conflict-handler-callouts
97+
98+
99+
// P2P snippets
100+
listener-config-client-auth-lambda
101+
listener-config-client-auth-pwd
102+
listener-config-client-auth-root
103+
listener-config-db
104+
listener-config-delta-sync
105+
listener-config-netw-iface
106+
listener-config-port
107+
listener-config-tls-disable
108+
listener-config-tls-enable
109+
listener-config-tls-id-anon
110+
listener-config-tls-id-caCert
111+
listener-config-tls-id-full
112+
listener-config-tls-id-SelfSigned
113+
listener-config-tls-id-set
114+
listener-get-network-interfaces
115+
listener-initialize
116+
listener-local-db
117+
listener-pv-cfg-conflict
118+
listener-simple
119+
listener-start
120+
listener-status-check
121+
listener-stop
122+
p2p-act-rep-add-change-listener
123+
p2p-act-rep-add-change-listener-label
124+
p2p-act-rep-auth
125+
p2p-act-rep-config-cacert-pinned
126+
p2p-act-rep-config-cacert-pinned-callouts
127+
p2p-act-rep-config-cacert
128+
p2p-act-rep-config-cont
129+
p2p-act-rep-config-self-cert
130+
p2p-act-rep-config-type
131+
p2p-act-rep-func
132+
p2p-act-rep-start-full
133+
p2p-act-rep-status
134+
p2p-act-rep-stop
135+
p2p-tlsid-check-bundled
136+
p2p-tlsid-check-keychain
137+
p2p-tlsid-delete-id-from-keychain
138+
p2p-tlsid-import-from-bundled
139+
p2p-tlsid-return-id-from-keychain
140+
p2p-tlsid-store-in-keychain
141+
p2p-tlsid-tlsidentity-with-label
142+
replicator-simple
143+
sgw-act-rep-initialize
144+
sgw-repl-pull
145+
sgw-repl-pull-callouts
146+
stopWebsocketsListener

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

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
// Begin -- Source Languages
3939
:langAndroid: android
4040
:langAndroidFull: java-android
41+
:langClang: clang
4142
:langCsharp: csharp
4243
:langJava: java
4344
:langJavaFull: java
@@ -46,30 +47,35 @@
4647
:langObjcFull: objective-c
4748
:langSwift: swift
4849
:platform-android: android
50+
:platform-clang: clang
4951
:platform-jvm: jvm
5052
:platform-ios: ios
5153
:platform-web: web
5254
:platform-net: net
5355

5456
// Couchbase Lite
5557
:lang-mod-android: android
58+
:lang-mod-clang: clang
5659
:lang-mod-csharp: csharp
5760
:lang-mod-java: java
5861
:lang-mod-objc: objc
5962
:lang-mod-swift: swift
60-
:lang-name-android: java-android
63+
:lang-name-android: kotlin-or-java
64+
:lang-name-clang: clang
6165
:lang-name-csharp: csharp
6266
:lang-name-java: java
6367
:lang-name-objc: objc
6468
:lang-name-swift: swift
6569
:lang-name-javascript: javascript
6670
:lang-platform-android: {platform-android}
71+
:lang-platform-clang: {platform-clang}
6772
:lang-platform-csharp: {platform-net}
6873
:lang-platform-java: {platform-jvm}
6974
:lang-platform-objc: {platform-ios}
7075
:lang-platform-swift: {platform-ios}
7176
:lang-platform-javascript: {platform-web}
72-
:lang-title-android: Android (Java)
77+
:lang-title-android: Android
78+
:lang-title-clang: C
7379
:lang-title-csharp: C#/.Net
7480
:lang-title-java: Java
7581
:lang-title-objc: Objective C
@@ -87,6 +93,7 @@
8793
:nmSampleAppPassword: password
8894
:nmLangJava: java
8995
:nmLangJS: javascript
96+
:nmLangClang: C
9097
:nmLangNet: C#/.Net
9198
:nmLangSwift: Swift
9299
:nmLangobjc: Objective-C
@@ -128,6 +135,7 @@
128135
// deprecated that
129136

130137
:url-download-swift: https://packages.couchbase.com/releases/couchbase-lite-ios/2.8.0-beta/couchbase-lite-swift_community_2.8.0.zip[Couchbase Lite Swift]
138+
:url-download-clang: https://packages.couchbase.com/releases/couchbase-lite-c/2.8.0-beta/couchbase-lite-objc_community_2.8.0.zip[Couchbase Lite C]
131139
:url-download-objc: https://packages.couchbase.com/releases/couchbase-lite-ios/2.8.0-beta/couchbase-lite-objc_community_2.8.0.zip[Couchbase Lite ObjC]
132140
:url-download-android: https://packages.couchbase.com/releases/couchbase-lite-android/2.8.0-beta/couchbase-lite-android_community_2.8.0.zip[Couchbase Lite Android]
133141
:url-download-java: https://packages.couchbase.com/releases/couchbase-lite-java/2.8.0-beta/couchbase-lite-java_community_2.8.0.zip[Couchbase Lite Java]
@@ -141,6 +149,7 @@
141149
:url-api-references-production: http://docs.couchbase.com/mobile/{version-full}/couchbase-lite-
142150
:url-api-references-pfx: {url-api-references-production}
143151
:url-api-references-android: {url-api-references-pfx}{lang-mod-android}
152+
:url-api-references-clang: {url-api-references-pfx}c
144153
:url-api-references-csharp: {url-api-references-pfx}net
145154
// :url-api-references-csharp: {url-api-references-pfx}{lang-mod-csharp}
146155
:url-api-references-java: {url-api-references-pfx}{lang-mod-java}
@@ -159,6 +168,7 @@
159168

160169
// Issue Links
161170
:url-issues-android: {url-github-cbl}-android/issues
171+
:url-issues-clang: {url-github-cbl}-c/issues
162172
:url-issues-csharp: {url-github-cbl}-csharp/issues
163173
:url-issues-java: {url-github-cbl}-android/issues
164174
:url-issues-objc: {url-github-cbl}-ios/issues
@@ -178,6 +188,7 @@
178188

179189
:android-pages: {lang-mod-android}:page$
180190
:android-examples: {lang-mod-android}:example$
191+
:clang-examples: {lang-mod-clang}:example$
181192
:csharp-examples: {lang-mod-csharp}:example$
182193
:java-examples: {lang-mod-java}:example$
183194
:objc-examples: {lang-mod-objc}:example$
@@ -186,12 +197,14 @@
186197
:snippets-pfx--android: example$java-android/app/src/main/java/com/couchbase
187198
:snippets-pfx: example$code_snippets/
188199
:snippets-content--android: {lang-mod-android}:{snippets-pfx--android}/code_snippets/Examples.java
200+
:snippets-content--clang: {lang-mod-clang}:{snippets-pfx}SampleCodeTest.cc
189201
:snippets-content--csharp: {lang-mod-csharp}:{snippets-pfx}Program.cs
190202
:snippets-content--java: {lang-mod-java}:{snippets-pfx}Examples.java
191203
:snippets-content--objc: {lang-mod-objc}:{snippets-pfx}SampleCodeTest.m
192204
:snippets-content--swift: {lang-mod-swift}:{snippets-pfx}SampleCodeTest.swift
193205

194206
:snippets-p2psync-ws--android: {lang-mod-android}:{snippets-pfx--android}/code_snippets/p2psync-websocket.java
207+
:snippets-p2psync-ws--clang: {snippets-content--clang}
195208
:snippets-p2psync-ws--csharp: {lang-mod-csharp}:{snippets-pfx}p2psync-websocket.cs
196209
:snippets-p2psync-ws--java: {lang-mod-java}:{snippets-pfx}p2psync-websocket.java
197210
:snippets-p2psync-ws--objc: {lang-mod-objc}:{snippets-pfx}p2psync-websocket.m
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.xref:couchbase-lite:clang:quickstart.adoc[{param-title}]
2+
// tag::get-started[]
3+
* xref:{cbl-pg-prereqs}[Start Here!]
4+
// tag::start[]
5+
** {xref-cbl-pg-install}
6+
// end::start[]
7+
** {xref-cbl-pg-build}
8+
// end::get-started[]
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// BEGIN -- inclusion/Menu part -- {root-partials}nav-skeleton-troubleshooting-<module>.adoc
2+
// Used-by -- {root-partials}nav-skeleton.adoc
3+
// Relies-on -- module context and especially, a loaded page-index.adoc
4+
** {xref-cbl-pg-troubleshooting-logs}
5+
** {xref-cbl-pg-troubleshooting-queries}
6+
// ** {xref-cbl-pg-troubleshooting-crashes}
7+
// END -- inclusion/Menu part -- {root-partials}nav-skeleton-troubleshooting-<module>.adoc
Loading
106 KB
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)