DOC-9047-C42 -- More misc fixes (xrefs etc) (#622)

https://issues.couchbase.com/browse/DOC-9047

Author: ibsoln

modules/ROOT/pages/_partials/commons/common-compatibility.adoc

@@ -86,11 +86,9 @@ h|.NET
 // * End of Life for support occurs 30 months after release date or, if longer, 6 months after the next Major Release.
 // * End of Support occurs 18 months after the End of Life date. +
 // Beyond this point customers should have migrated all production instances to a fully supported version.
-https://github.com/couchbase/docs-sdk-common/blob/release/7.0/
-modules/shared/partials/interface-stability-pars.adoc
 
-modules/shared:partial$interface-stability-pars.adoc
 include::sdk:shared:partial$interface-stability-pars.adoc[tag=interface-stability-section]
+
 // include::6.0@sdk:shared:partial$interface-stability-pars.adoc[tag=interface-stability-section]
 
 // DO NOT EDIT -- Footer Related Content Block

modules/ROOT/pages/_partials/commons/common-document.adoc

@@ -58,8 +58,16 @@ include::{root-partials}_block_tabbed_code_example.adoc[]
 == Mutability
 
 ifdef::is-c[]
-Couchbase Lite for C's documents can be either mutable or immutable.
-Immutable objects are referenced by `const` pointers; mutable ones by non-const pointers to prevent developers from accidentally calling a mutable-document function on an immutable document.
+Couchbase Lite for C's document objects `CBLDocument*` can be either mutable or immutable.
+Reference an immutable document using a `const` pointer and a mutable document using a non-const pointer to prevent developers from accidentally calling a mutable-document function on an immutable document.
+
+To make an immutable document mutable, you need to use {url-api-method-mutabledocument-copy}
+
+[source,{source-language}, subs="attributes+, macros+"]
+----
+CBLDocument* CBLDocument_MutableCopy(const CBLDocument* doc _cbl_nonnull)
+_cbl_warn_unused _cbl_returns_nonnull;
+----
 
 endif::is-c[]
 ifndef::is-c[]
@@ -83,11 +91,12 @@ ifndef::is-c[]
 == Typed Accessors
 
 === Scalar type
-The `Document` class now offers a set of {url-api-class-dictionary} for various scalar types, including boolean, integers, floating-point and strings.
-These accessors take care of converting to/from JSON encoding, and make sure you get the type you're expecting.
+The `Document` class now offers a set of property accessors for various scalar types, including boolean, integers, floating-point and strings.
+These accessors take care of converting to/from JSON encoding, and make sure you get the type you're expecting.+
+See: {url-api-class-dictionary}.
 
 endif::[]
-ifndef::-is-c[]
+ifndef::is-c[]
 === Date accessors
 // DateTimeOffset c#
 In addition, as a convenience we offer `Date` accessors.
@@ -103,10 +112,12 @@ include::{root-partials}_block_tabbed_code_example.adoc[]
 endif::[]
 
 
+ifndef::is-c,is-objc[]
 === Checking for properties
 To check whether a given property exists in the document, you should use the {url-api-method-document-contains} method.
 
 If the property doesn't exist in the document it will return the default value for that getter method (0 for {url-api-method-document-getint} 0.0 for {url-api-method-document-getfloat} etc.).
+endif::[]
 
 
 ifeval::["{param-module}"=="swift"]

modules/c/pages/_partials/_attributes-module.adoc

@@ -57,6 +57,14 @@
 :url-api-references-documents: {url-api-references-classes}{api-pfx}documents.html
 :url-api-class-documents: {url-api-references-documents}[{api-pfx}Documents]
 
+:url-api-method-document-init: {url-api-references-documents}#ga226f555fffb7543558048af20b18b737[CBLDocument_Create()]
+:url-api-method-mutabledocument-init: {url-api-references-documents}#ga226f555fffb7543558048af20b18b737[CBLDocument_Create()]
+:url-api-method-mutabledocument-initid: {url-api-references-documents}#gaec41cf2eab4e3ac490f11007f665a35e[CBLDocument_CreateWithID()]
+:url-api-method-mutabledocument-copy: {url-api-references-documents}#ga0356b98d2f1798adc8f549510d3eef67[CBLDocument_MutableCopy()]
+:url-api-method-document-tomutable: {url-api-method-mutabledocument-copy}
+
+:url-api-method-database-getdocument: {url-api-references-documents}#ga214b7d6c7d58bde09de10f1ed418a16b[ CBLDatabase_GetDocument()]
+
 :url-api-method-database-save-doc: {url-api-references-documents}{sep}[{api-pfx}CBLDatabase_SaveDocument()]
 :url-api-method-database-save-concctrl: {url-api-references-documents}{sep}gae37e21b95f62419762e521f70850b9c7[{api-pfx}CBLDatabase_SaveDocumentWithConcurrencyControl()]
 :url-api-method-database-save-conflict: {url-api-references-documents}{sep}ga9c45bcf02e6e2977c702c493a7fe0b54[{api-pfx}CBLDatabase_SaveDocumentWithConflictHandler()]
@@ -218,6 +226,8 @@
 :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-method-sep}{api-pfx}ReplicatorStatus
+:url-api-property-replicator-status: url-api-properties-replicator-status
+
 
 :url-api-enum-replicator-activity: {url-api-properties-replicator-status}(py)activity[activity enum]
 

modules/c/pages/field-level-encryption.adoc

@@ -35,14 +35,14 @@ The client-side encryption is compatible with the Couchbase server SDK field-lev
 
 == Encryptable Type
 
-The API includes a `CBLEncryptable` type, representing an encryptable value to be automatically encrypted/decryped the replicator -- see <<ex-encryptabe-type>>.
+The API includes a `CBLEncryptable` type, representing an encryptable value to be automatically encrypted/decrypted the replicator -- see <<ex-encryptable-type>>.
 
-You declare  properties requiring encryption by the replicator, as a dictionary with the structure shown in <<ex-encryptabe-type>>.
+You declare  properties requiring encryption by the replicator, as a dictionary with the structure shown in <<ex-encryptable-type>>.
 
-[#ex-encryptabe-type]
+[#ex-encryptable-type]
 .Encryptable-type Dictionary Structure
 ====
-[source, {source-langauge}]
+[source, {source-language}]
 ----
 {
   "@type": "encryptable",
@@ -66,7 +66,7 @@ The key for the value can be either of the following:
 == Replicator Decryption
 Pull replication detects `encryptable` values before saving them to the local database and decrypts them using the property decryption callback function -- see: <<lbl-decryption-callback>> for more on the decryption callback function.
 
-On successful decryption the replicator saves the property in encryptable dictionary format (removing the `encrypted$` prefix) -- see: <<ex-encryptabe-type>>.
+On successful decryption the replicator saves the property in encryptable dictionary format (removing the `encrypted$` prefix) -- see: <<ex-encryptable-type>>.
 
 
 == Replicator Encryption
@@ -102,7 +102,7 @@ Pull replicator::
 * Transforms the dictionary by:
 ** Removing `alg`
 ** Replacing the `ciphertext` key with the `value`
-** Storing the decrypted key/value in <<ex-encryptabe-type,CBLEncryptable>> format
+** Storing the decrypted key/value in <<ex-encryptable-type,CBLEncryptable>> format
 
 
 .Server SDK Encrypted Field Structure
@@ -194,7 +194,7 @@ CBLEncryptable exposes a _value_ property for query purposes.
 If this value is encrypted the query will return _MISSING_.
 
 [#ex-query]
-.A Simple Encryptabe Query
+.A Simple encryptable Query
 ====
 [source, nql]
 ----
@@ -203,8 +203,8 @@ SELECT  ssn,  // <.>
 FROM db WHERE ssn.value = "123-45-6789"
 ----
 
-<.> The returned `ssn` columm is in the form of an encryptable dictionary
-<.> The returned `ssn.value` columm is the actual value, unless it is still encrypted in which case it returns MISSING
+<.> The returned `ssn` column is in the form of an encryptable dictionary
+<.> The returned `ssn.value` column is the actual value, unless it is still encrypted in which case it returns MISSING
 ====
 
 

modules/csharp/pages/_partials/_attributes-module.adoc

@@ -105,11 +105,11 @@
 
 :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-toJSON: {url-api-classes-result-pfx}{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-toDictionary: {url-api-classes-result-pfx}{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()]
+:url-api-method-result-toList: {url-api-classes-result-pfx}{sep}Couchbase_Lite_Query_Result_ToList[{api-pfx}Result.ToList()]
 
 // Query class and methods
 :url-api-references-query: {url-api-references2}Query

modules/java/pages/java-ref-api.adoc

@@ -38,6 +38,32 @@
 :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()]
 
+// Dictionary Class
+:url-api-references-dictionary: Dictionary.html
+:url-api-class-dictionary: {url-api-references-dictionary}[{api-pfx}Dictionary]
+:url-api-class-mutabledictionary: {url-api-references-dictionary}[{api-pfx}MutableDictionary]
+
+:url-api-protocols-dictionary: {url-api-references-protocols}{api-pfx}Dictionary.html[{api-pfx}Dictionary]
+:url-api-protocols-dictionary-dateForKey: {url-api-references-protocols}{api-pfx}Dictionary.html#/c:objc(pl)CBLDictionary(im)dateForKey:[dateForKey:]
+
+:url-api-method-document-getdate: {url-api-protocols-dictionary-dateForKey}
+
+
+// Docuument Class
+:url-api-references-document: {url-api-references-classes}{api-pfx}MutableDocument.html
+:url-api-references-mutabledocument: {url-api-references-classes}{api-pfx}MutableDocument.html
+:url-api-class-document: {url-api-references-classes}{api-pfx}Document.html[{api-pfx}Document]
+:url-api-class-mutabledocument: {url-api-references-classes}{api-pfx}MutableDocument.html[{api-pfx}MutableDocument]
+:url-api-method-mutabledocument-initid: {url-api-references-mutabledocument}{sep}c:objc(cs)CBLMutableDocument(im)initWithID:[(nonnull instancetype)initWithID:(nullable NSString *)documentID;]
+:url-api-method-mutabledocument-init: {url-api-references-mutabledocument}{sep}c:objc(cs)CBLMutableDocument(im)init[(nonnull instancetype)init;]
+
+:url-api-method-database-getdocument: {url-api-references-database}{sep}c:objc(cs)CBLDatabase(im)documentWithID:[(nullable CBLDocument *)documentWithID:(nonnull NSString *)id;]
+
+:url-api-method-document-tomutable: {url-api-references-document}c:objc(cs)CBLDocument(im)toMutable[(nonnull CBLMutableDocument *)toMutable;]
+
+:url-api-method-mutabledocument-getWithID: {url-api-references-mutabledocument}{sep}c:objc(cs)CBLMutableDocument(cm)documentWithID:[(nonnull instancetype)documentWithID:(nullable NSString *)documentID;]
+
+
 // Begin -- DatabaseConfiguration
 :url-api-references-databasecfg: {url-api-references-classes}{api-pfx}DatabaseConfiguration.html
 :url-api-class-databasecfg: {url-api-references-databasecfg}[DatabaseConfiguration]