Skip to content

Commit

Permalink
DOC-8131 -- C Productization -- Prepare asciidoc module (couchbase#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
ibsoln committed Aug 11, 2021
1 parent 056be47 commit 0cd4a48
Show file tree
Hide file tree
Showing 54 changed files with 3,854 additions and 2 deletions.
1 change: 1 addition & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ start_page: couchbase-lite:ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc
- modules/android/nav-android.adoc
- modules/clang/nav-clang.adoc
- modules/csharp/nav-csharp.adoc
- modules/java/nav-java.adoc
- modules/objc/nav-objc.adoc
Expand Down
146 changes: 146 additions & 0 deletions modules/ROOT/examples/inclusion-tags-used.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Query: include::{snippet}
# Flags: IgnoreExcludeSettings
# Including: ./cbl/modules/ROOT
# ContextLines: 1

1x-attachment
active-peer-close
active-peer-open
active-peer-receive
active-peer-send
active-replicator-close
add-document-replication-listener
advertizer-accept
basic-authentication
batch
blob
certificate-pinning
console-logging
coreml-predictive-model
create-connection
custom-logging
database-encryption
database-replica
date-getter
document-expiration
document-listener
file-logging
fts-index
fts-query
getting-started
initializer
listener
listener-config-client-auth-pwd-full
listener-config-delete-cert-full
live-query
local-win-conflict-resolver
logging
merge-conflict-resolver
message-endpoint
message-endpoint-replicator
new-database
p2psync-act-tlsid-create
p2psync-act-tlsid-delete
p2psync-act-tlsid-import
passive-peer-close
passive-peer-open
passive-peer-receive
passive-peer-send
passive-replicator-close
passive-stop-listener
prebuilt-database
predictive-model
predictive-query
predictive-query-predictive-index
predictive-query-value-index
query-collection-operator-contains
query-collection-operator-in
query-deleted-documents
query-explain-all
query-explain-function
query-explain-like
query-explain-nofunction
query-explain-nopfx
query-groupby
query-index
query-join
query-like-operator
query-like-operator-wildcard-character-match
query-like-operator-wildcard-match
query-orderby
query-regex-operator
query-select-all
query-select-meta
query-where
register-model
remote-win-conflict-resolver
remove-document-replication-listener
replication-conflict-resolver
replication-custom-header
replication-error-handling
replication-logging
replication-pendingdocuments
replication-pull-filter
replication-push-filter
replication-reset-checkpoint
replication-set-heartbeat
replication-status
sdk-initializer
session-authentication
set-custom-logging
stop-live-query
to-dictionary
unregister-model
update-document
update-document-with-conflict-handler
update-document-with-conflict-handler-callouts


// P2P snippets
listener-config-client-auth-lambda
listener-config-client-auth-pwd
listener-config-client-auth-root
listener-config-db
listener-config-delta-sync
listener-config-netw-iface
listener-config-port
listener-config-tls-disable
listener-config-tls-enable
listener-config-tls-id-anon
listener-config-tls-id-caCert
listener-config-tls-id-full
listener-config-tls-id-SelfSigned
listener-config-tls-id-set
listener-get-network-interfaces
listener-initialize
listener-local-db
listener-pv-cfg-conflict
listener-simple
listener-start
listener-status-check
listener-stop
p2p-act-rep-add-change-listener
p2p-act-rep-add-change-listener-label
p2p-act-rep-auth
p2p-act-rep-config-cacert-pinned
p2p-act-rep-config-cacert-pinned-callouts
p2p-act-rep-config-cacert
p2p-act-rep-config-cont
p2p-act-rep-config-self-cert
p2p-act-rep-config-type
p2p-act-rep-func
p2p-act-rep-start-full
p2p-act-rep-status
p2p-act-rep-stop
p2p-tlsid-check-bundled
p2p-tlsid-check-keychain
p2p-tlsid-delete-id-from-keychain
p2p-tlsid-import-from-bundled
p2p-tlsid-return-id-from-keychain
p2p-tlsid-store-in-keychain
p2p-tlsid-tlsidentity-with-label
replicator-simple
sgw-act-rep-initialize
sgw-repl-pull
sgw-repl-pull-callouts
stopWebsocketsListener
17 changes: 15 additions & 2 deletions modules/ROOT/pages/_partials/_attributes-local.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
// Begin -- Source Languages
:langAndroid: android
:langAndroidFull: java-android
:langClang: clang
:langCsharp: csharp
:langJava: java
:langJavaFull: java
Expand All @@ -46,30 +47,35 @@
:langObjcFull: objective-c
:langSwift: swift
:platform-android: android
:platform-clang: clang
:platform-jvm: jvm
:platform-ios: ios
:platform-web: web
:platform-net: net

// Couchbase Lite
:lang-mod-android: android
:lang-mod-clang: clang
:lang-mod-csharp: csharp
:lang-mod-java: java
:lang-mod-objc: objc
:lang-mod-swift: swift
:lang-name-android: java-android
:lang-name-android: kotlin-or-java
:lang-name-clang: clang
:lang-name-csharp: csharp
:lang-name-java: java
:lang-name-objc: objc
:lang-name-swift: swift
:lang-name-javascript: javascript
:lang-platform-android: {platform-android}
:lang-platform-clang: {platform-clang}
:lang-platform-csharp: {platform-net}
:lang-platform-java: {platform-jvm}
:lang-platform-objc: {platform-ios}
:lang-platform-swift: {platform-ios}
:lang-platform-javascript: {platform-web}
:lang-title-android: Android (Java)
:lang-title-android: Android
:lang-title-clang: C
:lang-title-csharp: C#/.Net
:lang-title-java: Java
:lang-title-objc: Objective C
Expand All @@ -87,6 +93,7 @@
:nmSampleAppPassword: password
:nmLangJava: java
:nmLangJS: javascript
:nmLangClang: C
:nmLangNet: C#/.Net
:nmLangSwift: Swift
:nmLangobjc: Objective-C
Expand Down Expand Up @@ -128,6 +135,7 @@
// deprecated that

: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]
: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]
: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]
: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]
: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]
Expand All @@ -141,6 +149,7 @@
:url-api-references-production: http://docs.couchbase.com/mobile/{version-full}/couchbase-lite-
:url-api-references-pfx: {url-api-references-production}
:url-api-references-android: {url-api-references-pfx}{lang-mod-android}
:url-api-references-clang: {url-api-references-pfx}c
:url-api-references-csharp: {url-api-references-pfx}net
// :url-api-references-csharp: {url-api-references-pfx}{lang-mod-csharp}
:url-api-references-java: {url-api-references-pfx}{lang-mod-java}
Expand All @@ -159,6 +168,7 @@

// Issue Links
:url-issues-android: {url-github-cbl}-android/issues
:url-issues-clang: {url-github-cbl}-c/issues
:url-issues-csharp: {url-github-cbl}-csharp/issues
:url-issues-java: {url-github-cbl}-android/issues
:url-issues-objc: {url-github-cbl}-ios/issues
Expand All @@ -178,6 +188,7 @@

:android-pages: {lang-mod-android}:page$
:android-examples: {lang-mod-android}:example$
:clang-examples: {lang-mod-clang}:example$
:csharp-examples: {lang-mod-csharp}:example$
:java-examples: {lang-mod-java}:example$
:objc-examples: {lang-mod-objc}:example$
Expand All @@ -186,12 +197,14 @@
:snippets-pfx--android: example$java-android/app/src/main/java/com/couchbase
:snippets-pfx: example$code_snippets/
:snippets-content--android: {lang-mod-android}:{snippets-pfx--android}/code_snippets/Examples.java
:snippets-content--clang: {lang-mod-clang}:{snippets-pfx}SampleCodeTest.cc
:snippets-content--csharp: {lang-mod-csharp}:{snippets-pfx}Program.cs
:snippets-content--java: {lang-mod-java}:{snippets-pfx}Examples.java
:snippets-content--objc: {lang-mod-objc}:{snippets-pfx}SampleCodeTest.m
:snippets-content--swift: {lang-mod-swift}:{snippets-pfx}SampleCodeTest.swift

:snippets-p2psync-ws--android: {lang-mod-android}:{snippets-pfx--android}/code_snippets/p2psync-websocket.java
:snippets-p2psync-ws--clang: {snippets-content--clang}
:snippets-p2psync-ws--csharp: {lang-mod-csharp}:{snippets-pfx}p2psync-websocket.cs
:snippets-p2psync-ws--java: {lang-mod-java}:{snippets-pfx}p2psync-websocket.java
:snippets-p2psync-ws--objc: {lang-mod-objc}:{snippets-pfx}p2psync-websocket.m
Expand Down
8 changes: 8 additions & 0 deletions modules/ROOT/pages/_partials/nav-skeleton-start-clang.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.xref:couchbase-lite:clang:quickstart.adoc[{param-title}]
// tag::get-started[]
* xref:{cbl-pg-prereqs}[Start Here!]
// tag::start[]
** {xref-cbl-pg-install}
// end::start[]
** {xref-cbl-pg-build}
// end::get-started[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// BEGIN -- inclusion/Menu part -- {root-partials}nav-skeleton-troubleshooting-<module>.adoc
// Used-by -- {root-partials}nav-skeleton.adoc
// Relies-on -- module context and especially, a loaded page-index.adoc
** {xref-cbl-pg-troubleshooting-logs}
** {xref-cbl-pg-troubleshooting-queries}
// ** {xref-cbl-pg-troubleshooting-crashes}
// END -- inclusion/Menu part -- {root-partials}nav-skeleton-troubleshooting-<module>.adoc
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/clang/assets/images/info-plist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/clang/assets/images/run-script-copy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/clang/assets/images/run-script-phase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0cd4a48

Please sign in to comment.