DOC-8590 -- include kotlin example placeholder (couchbase#479)

ibsoln · Jun 10, 2021 · bbec4dc · bbec4dc
1 parent 19ab2e0
commit bbec4dc
Show file tree

Hide file tree

Showing 7 changed files with 124 additions and 41 deletions.
diff --git a/.gitignore b/.gitignore
@@ -98,4 +98,8 @@ deploy/.vagrant/
 modules/ROOT/holding-bin/**
 modules/ROOT/temp-bin/**
 modules/swift/examples/thisbin/**
-modules/swift/examples/CouchbaseLiteSwift.xcframework/**
+modules/swift/examples/CouchbaseLiteSwift.xcframework/**
+
+modules/android/examples/docsnippets/**
+modules/android/examples/jsonsnippets/**
+
diff --git a/modules/ROOT/pages/_partials/commons/common-querybuilder.adoc b/modules/ROOT/pages/_partials/commons/common-querybuilder.adoc
@@ -688,19 +688,57 @@ TIP: For more on using the QueryBuilder API, see our blog: {url-cb-blog-query-in
 
 Couchbase Lite for {param-title} provides a convenience API to convert query results to JSON strings.
 
-Use {url-api-class-result-toJSON} to transform your result string into a JSON string, which can easily be serialized or used as required in your application. See <<ex-json>> for a working example.
-
+Use {url-api-method-result-toJSON} to transform your result string into a JSON string, which can easily be serialized or used as required in your application. See <<ex-json>> for a working example.
 
 [#ex-json]
 .Using JSON Results
 ====
-[{code-snippet}]
+
+ifdef::is-android[]
+
+[{tabs}]
+=====
+
+Kotlin::
++
+--
+
+[source, kotlin]
 ----
 
-include::{snippet}[tags=query-access-json]
+include::{snippet-alt}[tags=query-access-json, indent=0]
 
 ----
 
+--
+
+Java::
++
+--
+
+endif::is-android[]
+
+[source, {source-language}]
+----
+
+include::{snippet}[tags=query-access-json, indent=0]
+
+----
+
+ifdef::is-android[]
+
+--
+
+=====
+
+endif::is-android[]
+
+<.> Get the Query result as a JSON string
+
+<.> Get a JSON object from the JSON string
+
+<.> Get a native object from the JSON object
+
 ====
 
 

diff --git a/modules/android/pages/_partials/_attributes-module.adoc b/modules/android/pages/_partials/_attributes-module.adoc
@@ -7,10 +7,10 @@
 :module: {param-module}
 :packageNm: couchbase-lite-{module}
 // :snippet-p2psync-ws: {snippets-p2psync-ws--android}
-:snippet: {snippets-content--android-kotlin}
-:snippet-alt: {snippets-content--android-java}
-:source-language: Kotlin
-:source-language-alt: Java
+:snippet-alt: {snippets-content--android-kotlin}
+:snippet: {snippets-content--android-java}
+:source-language: Java
+:source-language-alt: Kotlin
 :docsnippet: snippets-android-docsnippets}
 :url-issues: {url-issues-android}
 :url-download-package: {url-download-android}
@@ -26,6 +26,7 @@
 :url-api-references: {url-api-references-android}/
 :url-api-references-classes: {url-api-references}index.html?com/couchbase/lite/
 :url-api-references-structs: {url-api-references-classes}
+:url-api-references-method-sep: {sep}
 
 :url-api-references-database: {url-api-references-classes}{api-pfx}Database.html
 :url-api-class-database: {url-api-references-database}[Database]
@@ -83,6 +84,14 @@
 
 // QUERY RELATED CLASSES and METHODS
 
+// Result Classes and Methods
+
+:url-api-classes-result-pfx: {url-api-references-classes}{api-pfx}Result.html
+
+:url-api-class-result: {url-api-classes-result-pfx}[{api-pfx}Result]
+
+:url-api-method-result-toJSON: {url-api-classes-result-pfx}{url-api-references-method-sep}{api-pfx}toJSON--[{api-pfx}Result.toJSON()]
+
 // Query class and methods
 :url-api-classes-query-pfx: {url-api-references-classes}{api-pfx}Query.html
 :url-api-class-query: {url-api-classes-query-pfx}[Query]

diff --git a/modules/csharp/pages/_partials/_attributes-module.adoc b/modules/csharp/pages/_partials/_attributes-module.adoc
@@ -98,6 +98,17 @@
 
 // QUERY RELATED CLASSES and METHODS
 
+// Result Classes and Methods
+
+:url-api-classes-result-pfx: {url-api-references-classes}{api-pfx}Query.Result.html
+
+:url-api-class-result: {url-api-classes-result-pfx}[{api-pfx}Result]
+
+:url-api-method-result-toJSON: {url-api-classes-result-pfx}{url-api-references-method-sep}Couchbase_Lite_Query_Result_ToJson[{api-pfx}Result.ToJson()]
+
+:url-api-method-result-toDictionary: {url-api-classes-result-pfx}{url-api-references-method-sep}Couchbase_Lite_Query_Result_ToDictionary[{api-pfx}Result.ToDictionary()]
+
+:url-api-method-result-toList: {url-api-classes-result-pfx}{url-api-references-method-sep}Couchbase_Lite_Query_Result_ToList[{api-pfx}Result.ToList()]
 
 // Query class and methods
 :url-api-references-query: {url-api-references2}Query

diff --git a/modules/java/pages/_partials/_attributes-module.adoc b/modules/java/pages/_partials/_attributes-module.adoc
@@ -21,19 +21,20 @@
 // :snippet-p2psync-ws: {snippets-p2psync-ws--java}
 :url-issues: {url-issues-java}
 :sep: #
+:api-pfx:
 :hdIndent:
 // END -- module page attributes
 
 
 // BEGIN -- Define API References for this module
 //  These attributes s
-:api-pfx:
 :url-api-references: {url-api-references-java}/index.html?
 //:url-api-references-structs: {url-api-references}Structs
 :url-api-references-classes: {url-api-references}com/couchbase/lite/
 // :url-api-references-classes: {url-api-references}Classes
 :url-api-references-structs: {url-api-references-classes}
 :url-api-references-enums: {url-api-references}Enums
+:url-api-references-method-sep: {sep}
 
 :url-api-references-database: {url-api-references-classes}{api-pfx}Database.html
 :url-api-class-database: {url-api-references-database}[Database]
@@ -92,6 +93,14 @@
 
 // QUERY RELATED CLASSES and METHODS
 
+// Result Classes and Methods
+
+:url-api-classes-result-pfx: {url-api-references-classes}{api-pfx}Result.html
+
+:url-api-class-result: {url-api-classes-result-pfx}[{api-pfx}Result]
+
+:url-api-method-result-toJSON: {url-api-classes-result-pfx}{url-api-references-method-sep}{api-pfx}toJSON--[{api-pfx}Result.toJSON()]
+
 // Query class and methods
 :url-api-classes-query-pfx: {url-api-references-classes}{api-pfx}Query.html
 :url-api-class-query: {url-api-classes-query-pfx}[Query]

diff --git a/modules/objc/pages/_partials/_attributes-module.adoc b/modules/objc/pages/_partials/_attributes-module.adoc
@@ -25,12 +25,12 @@
 :url-api-references-protocols: {url-api-references}/Protocols/
 :url-api-references-structs: {url-api-references-classes}
 :url-api-references-enums: {url-api-references}/Enums/
-:url-api-references-objc-sep: {sep}c:objc(cs)
+:url-api-references-method-sep: {sep}c:objc(cs)
 
 // DATABASE CLASSES
 :url-api-references-database: {url-api-references-classes}{api-pfx}Database.html
 :url-api-class-database: {url-api-references-database}[{api-pfx}Database]
-:url-api-method-database: {url-api-references-database}{url-api-references-objc-sep}{api-pfx}Database(im)
+:url-api-method-database: {url-api-references-database}{url-api-references-method-sep}{api-pfx}Database(im)
 :url-api-method-database-close: {url-api-method-database}close:[{api-pfx}Database.Close()]
 :url-api-method-database-delete: {url-api-method-database}delete:[{api-pfx}Database.Delete()]
 
@@ -56,20 +56,32 @@
 
 //Database.COMPACT
 :url-api-method-database-compact: {url-api-method-database}compact:[{api-pfx}Database.compact()]
-:url-api-method-database-copy: {url-api-references-database}{url-api-references-objc-sep}CBLDatabase(cm)copyFromPath:toDatabase:withConfig:error:[copyFromPath()]
+:url-api-method-database-copy: {url-api-references-database}{url-api-references-method-sep}CBLDatabase(cm)copyFromPath:toDatabase:withConfig:error:[copyFromPath()]
 :url-api-method-database-performMaintenance: {url-api-method-database}performMaintenance:error:[{api-pfx}Database.performMaintenance()]
 
 :url-api-method-database-setloglevel: {url-api-references-database}{sep}c:objc(cs)CBLDatabase(cm)setLogLevel:domain:[{api-pfx}Database.setLogLevel()]
 
 
 // QUERY RELATED CLASSES and METHODS
 
+// Result Classes and Methods
+
+:url-api-classes-result-pfx: {url-api-references-classes}{api-pfx}QueryResult.html
+
+:url-api-class-result: {url-api-classes-result-pfx}[{api-pfx}Result]
+
+:url-api-method-result-toJSON: {url-api-classes-result-pfx}{url-api-references-method-sep}{api-pfx}QueryResult(im)toJSON[{api-pfx}Result.toJSON]
+
 // Query class and methods
 :url-api-classes-query-pfx: {url-api-references-classes}{api-pfx}Query.html
 :url-api-class-query: {url-api-classes-query-pfx}[{api-pfx}Query]
-:url-api-method-query-explain: {url-api-classes-query-pfx}{url-api-references-objc-sep}CBLQuery(im)explain:[explain()]
+:url-api-method-query-explain: {url-api-classes-query-pfx}{url-api-references-method-sep}CBLQuery(im)explain:[explain()]
 :url-api-method-query-execute: {url-api-classes-query-pfx}{sep}execute--[execute()]
 
+
+
+
+
 // Expression class and methods
 // :url-api-references-query-classes: {url-api-references-classes}[Query Class index]
 :url-api-classes-expression-pfx: {url-api-references-classes}{api-pfx}QueryExpression.html
@@ -96,8 +108,8 @@
 //
 :url-api-classes-function-pfx: {url-api-references-classes}{api-pfx}QueryFunction.html
 :url-api-class-function: {url-api-classes-function-pfx}[{api-pfx}QueryFunction]
-:url-api-method-function-lower: {url-api-classes-function-pfx}{url-api-references-objc-sep}CBLQueryFunction(cm)lower:[lower()]
-:url-api-method-function-count: {url-api-classes-function-pfx}{url-api-references-objc-sep}CBLQueryFunction(cm)count:[count()]
+:url-api-method-function-lower: {url-api-classes-function-pfx}{url-api-references-method-sep}CBLQueryFunction(cm)lower:[lower()]
+:url-api-method-function-count: {url-api-classes-function-pfx}{url-api-references-method-sep}CBLQueryFunction(cm)count:[count()]
 
 // Where class and methods
 //
@@ -125,7 +137,7 @@
 
 
 :url-api-references-urlendpointlistener: {url-api-references-classes}{api-pfx}URLEndpointListener.html
-:url-api-references-urlendpointlistener-property: {url-api-references-urlendpointlistener}{url-api-references-objc-sep}CBLURLEndpointListener(py)
+:url-api-references-urlendpointlistener-property: {url-api-references-urlendpointlistener}{url-api-references-method-sep}CBLURLEndpointListener(py)
 :url-api-property-urlendpointlistener-status: {url-api-references-urlendpointlistener-property}status[status]
 :url-api-property-urlendpointlistener-urls: {url-api-references-urlendpointlistener-property}urls[urls]
 
@@ -137,17 +149,17 @@
 
 :url-api-class-tlsidentity: {url-api-references-tlsidentity}[TLSIdentity]
 
-:url-api-method-tls-identity-import: {url-api-references-tlsidentity}{url-api-references-objc-sep}{api-pfx}TLSIdentity(cm)importIdentityWithData:password:label:error:[importIdentity(withData:password:label:error:)]
+:url-api-method-tls-identity-import: {url-api-references-tlsidentity}{url-api-references-method-sep}{api-pfx}TLSIdentity(cm)importIdentityWithData:password:label:error:[importIdentity(withData:password:label:error:)]
 
-:url-api-method-tls-identity-create: {url-api-references-tlsidentity}{url-api-references-objc-sep}{api-pfx}TLSIdentity(cm)createIdentityForServer:attributes:expiration:label:error:[createIdentity()]
+:url-api-method-tls-identity-create: {url-api-references-tlsidentity}{url-api-references-method-sep}{api-pfx}TLSIdentity(cm)createIdentityForServer:attributes:expiration:label:error:[createIdentity()]
 
-:url-api-method-tls-identity-get: {url-api-references-tlsidentity}{url-api-references-objc-sep}{api-pfx}TLSIdentity(cm)identityWithLabel:error:[identityWithLabel:error]
+:url-api-method-tls-identity-get: {url-api-references-tlsidentity}{url-api-references-method-sep}{api-pfx}TLSIdentity(cm)identityWithLabel:error:[identityWithLabel:error]
 
-:url-api-method-tls-identity-get-withId: {url-api-references-tlsidentity}{url-api-references-objc-sep}{api-pfx}TLSIdentity(cm)identityWithIdentity:certs:error:[identityWithIdentity:certs:error]
+:url-api-method-tls-identity-get-withId: {url-api-references-tlsidentity}{url-api-references-method-sep}{api-pfx}TLSIdentity(cm)identityWithIdentity:certs:error:[identityWithIdentity:certs:error]
 
 :url-api-class-urlendpointconfiguration: {url-api-references-urlendpointconfiguration}[URLEndpointListenerConfiguration]
 
-:url-api-references-urlendpointconfiguration-property: {url-api-references-urlendpointconfiguration}{url-api-references-objc-sep}{api-pfx}URLEndpointListenerConfiguration
+:url-api-references-urlendpointconfiguration-property: {url-api-references-urlendpointconfiguration}{url-api-references-method-sep}{api-pfx}URLEndpointListenerConfiguration
 
 :url-api-references-urlendpointconfiguration-port: {url-api-references-urlendpointconfiguration-property}(py)port[port]
 
@@ -175,7 +187,7 @@
 :url-api-references-replicator: {url-api-references-classes}{api-pfx}Replicator.html
 :url-api-class-replicator: {url-api-references-replicator}[Replicator]
 
-:url-api-properties-replicator: {url-api-references-replicator}{url-api-references-objc-sep}{api-pfx}Replicator
+:url-api-properties-replicator: {url-api-references-replicator}{url-api-references-method-sep}{api-pfx}Replicator
 
 :url-api-method-replicator: {url-api-properties-replicator}(im)
 
@@ -204,7 +216,7 @@
 
 :url-api-class-replicator-status: {url-api-references-replicator-status}[{api-pfx}ReplicatorStatus]
 
-:url-api-properties-replicator-status: {url-api-references-replicator-status}{url-api-references-objc-sep}{api-pfx}ReplicatorStatus
+:url-api-properties-replicator-status: {url-api-references-replicator-status}{url-api-references-method-sep}{api-pfx}ReplicatorStatus
 
 :url-api-enum-replicator-activity: {url-api-properties-replicator-status}(py)activity[activity enum]
 
@@ -217,7 +229,7 @@
 
 :url-api-class-replicator-config: {url-api-references-replicator-config}[ReplicatorConfiguration]
 
-:url-api-references-replicator-config-prop: {url-api-references-replicator-config}{url-api-references-objc-sep}{api-pfx}ReplicatorConfiguration
+:url-api-references-replicator-config-prop: {url-api-references-replicator-config}{url-api-references-method-sep}{api-pfx}ReplicatorConfiguration
 
 :url-api-constructor-replicator-config-db-tgt: {url-api-references-replicator-config-prop}(im)initWithDatabase:target:[-initWithDatabase:target:]
 
@@ -261,7 +273,7 @@
 // Meta API
 :url-api-references-meta: {url-api-references-classes}{api-pfx}QueryMeta.html
 
-:url-api-property-meta-revisionid: {url-api-references-meta}{url-api-references-objc-sep}CBLQueryMeta(cm)revisionID[{api-pfx}QueryMeta.revisionID]
+:url-api-property-meta-revisionid: {url-api-references-meta}{url-api-references-method-sep}CBLQueryMeta(cm)revisionID[{api-pfx}QueryMeta.revisionID]
 
 
 
@@ -271,36 +283,36 @@
 :url-api-references-class-log: {url-api-references-classes}{api-pfx}Log.html
 :url-api-class-log: {url-api-references-class-log}[{api-pfx}Log]
 :url-api-class-log-prop-console: {url-api-references-class-log}{sep}3LogC7consoleAA13ConsoleLoggerCvp[{api-pfx}Log.console]
-:url-api-class-log-prop-file: {url-api-references-class-log}{url-api-references-objc-sep}CBLLog(py)file[{api-pfx}Log.file]
-:url-api-class-log-prop-custom: {url-api-references-class-log}{url-api-references-objc-sep}CBLLog(py)custom[{api-pfx}Log.custom]
+:url-api-class-log-prop-file: {url-api-references-class-log}{url-api-references-method-sep}CBLLog(py)file[{api-pfx}Log.file]
+:url-api-class-log-prop-custom: {url-api-references-class-log}{url-api-references-method-sep}CBLLog(py)custom[{api-pfx}Log.custom]
 
 :url-api-references-class-log-cons: {url-api-references-classes}{api-pfx}ConsoleLogger.html
 :url-api-class-log-console: {url-api-references-class-log-cons}[{api-pfx}ConsoleLogger]
-:url-api-class-log-console-getcons: {url-api-references-class-log}{url-api-references-objc-sep}CBLLog(py)console[{api-pfx}Log.console]
-:url-api-class-log-console-getcons-setlvl: {url-api-references-class-log-cons}{url-api-references-objc-sep}CBLConsoleLogger(py)level[{api-pfx}Log.console.level]
-:url-api-class-log-console-getcons-setdmn: {url-api-references-class-log-cons}{url-api-references-objc-sep}CBLConsoleLogger(py)domains[{api-pfx}Log.console.domains]
+:url-api-class-log-console-getcons: {url-api-references-class-log}{url-api-references-method-sep}CBLLog(py)console[{api-pfx}Log.console]
+:url-api-class-log-console-getcons-setlvl: {url-api-references-class-log-cons}{url-api-references-method-sep}CBLConsoleLogger(py)level[{api-pfx}Log.console.level]
+:url-api-class-log-console-getcons-setdmn: {url-api-references-class-log-cons}{url-api-references-method-sep}CBLConsoleLogger(py)domains[{api-pfx}Log.console.domains]
 
 :url-api-references-class-log-cust: {url-api-references-protocols}{api-pfx}Logger.html
 :url-api-iface-log-custom: {url-api-references-class-log-cust}[{api-pfx}Logger]
 :url-api-class-log-custom: {url-api-iface-log-custom}
-:url-api-class-log-custom-getcust: {url-api-references-class-log}{url-api-references-objc-sep}CBLLog(py)custom[{api-pfx}Log.custom]
-:url-api-class-log-custom-setcust: {url-api-references-class-log}{url-api-references-objc-sep}CBLLog(py)custom[{api-pfx}Log.custom]
-:url-api-class-log-custom-getcust-setlvl: {url-api-references-class-log-cust}{url-api-references-objc-sep}CBLLogger(py)level[{api-pfx}Log.custom.setLevel()]
-:url-api-class-log-custom-getfile-logmsg: {url-api-references-class-log-cust}{url-api-references-objc-sep})CBLLogger(im)logWithLevel:domain:message:[{api-pfx}Log(logWithlevel:,domain:, message:)]
+:url-api-class-log-custom-getcust: {url-api-references-class-log}{url-api-references-method-sep}CBLLog(py)custom[{api-pfx}Log.custom]
+:url-api-class-log-custom-setcust: {url-api-references-class-log}{url-api-references-method-sep}CBLLog(py)custom[{api-pfx}Log.custom]
+:url-api-class-log-custom-getcust-setlvl: {url-api-references-class-log-cust}{url-api-references-method-sep}CBLLogger(py)level[{api-pfx}Log.custom.setLevel()]
+:url-api-class-log-custom-getfile-logmsg: {url-api-references-class-log-cust}{url-api-references-method-sep})CBLLogger(im)logWithLevel:domain:message:[{api-pfx}Log(logWithlevel:,domain:, message:)]
 
 :url-api-references-class-log-file: {url-api-references-classes}{api-pfx}FileLogger.html
 :url-api-class-log-file: {url-api-references-class-log-file}[{api-pfx}FileLogger]
-:url-api-class-log-file-getfile: {url-api-references-class-log}{url-api-references-objc-sep}CBLLog(py)file[{api-pfx}Log.file]
-:url-api-class-log-file-getfile-setcfg: {url-api-references-class-log-file}{url-api-references-objc-sep}CBLFileLogger(py)config[{api-pfx}Log.file.config: LogConfiguration(directory:)]
-:url-api-class-log-file-getfile-setlvl: {url-api-references-class-log-file}{url-api-references-objc-sep})CBLFileLogger(py)level[{api-pfx}Log.file.level: LogLevel]
+:url-api-class-log-file-getfile: {url-api-references-class-log}{url-api-references-method-sep}CBLLog(py)file[{api-pfx}Log.file]
+:url-api-class-log-file-getfile-setcfg: {url-api-references-class-log-file}{url-api-references-method-sep}CBLFileLogger(py)config[{api-pfx}Log.file.config: LogConfiguration(directory:)]
+:url-api-class-log-file-getfile-setlvl: {url-api-references-class-log-file}{url-api-references-method-sep})CBLFileLogger(py)level[{api-pfx}Log.file.level: LogLevel]
 
-:url-api-class-log-file-getfile-logmsg: {url-api-references-class-log}{url-api-references-objc-sep}[{api-pfx}Log(level: LogLevel, domain: LogDomain, message: String)]
+:url-api-class-log-file-getfile-logmsg: {url-api-references-class-log}{url-api-references-method-sep}[{api-pfx}Log(level: LogLevel, domain: LogDomain, message: String)]
 
 :url-api-enum-log-domain: {url-api-references-enums}{api-pfx}LogDomain.html[{api-pfx}LogDomain]
 :url-api-enum-log-level: {url-api-references-enums}{api-pfx}LogLevel.html[{api-pfx}LogLevel]
 :url-api-references-class-log-config: {url-api-references-classes}{api-pfx}LogFileConfiguration.html
 :url-api-class-log-config: {url-api-references-class-log-config}[{api-pfx}LogFileConfiguration]
-:url-api-class-log-config-props: {url-api-references-class-log-config}{url-api-references-objc-sep}
+:url-api-class-log-config-props: {url-api-references-class-log-config}{url-api-references-method-sep}
 :url-api-class-log-config-prop-dir: {url-api-class-log-config-props}CBLLogFileConfiguration(py)directory[{api-pfx}LogFileConfiguration(Directory)]
 :url-api-class-log-config-prop-initdir: {url-api-class-log-config-props}20LogFileConfigurationC9directoryACSS_tcfc[{api-pfx}LogFileConfiguration.init((directory:)]
 :url-api-class-log-config-prop-maxsz: {url-api-class-log-config-props}CBLLogFileConfiguration(py)maxSize[{api-pfx}LogFileConfiguration.maxSize()]

diff --git a/modules/swift/pages/_partials/_attributes-module.adoc b/modules/swift/pages/_partials/_attributes-module.adoc
@@ -118,7 +118,7 @@
 :url-api-classes-result-pfx: {url-api-references-classes}{api-pfx}Result.html
 :url-api-class-result: {url-api-classes-result-pfx}[{api-pfx}Result]
 
-:url-api-class-result-toJSON: {url-api-classes-result-pfx}{api-pfx}s:18CouchbaseLiteSwift6ResultC6toJSONSSyF[result.toJSON()]
+:url-api-method-result-toJSON: {url-api-classes-result-pfx}{api-pfx}s:18CouchbaseLiteSwift6ResultC6toJSONSSyF[result.toJSON()]
 
 // Function class and methods
 //