Skip to content

Commit ab9c888

Browse files
AnkaAnka
Anka
authored and
Anka
committed
Update documentation to 157401b on 'release'
1 parent 849e1f2 commit ab9c888

File tree

22 files changed

+1588
-484
lines changed

22 files changed

+1588
-484
lines changed

‎release/data/documentation/parseswift.json

Lines changed: 168 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -476,8 +476,10 @@
476476
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/containsString(key:substring:modifiers:)",
477477
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/doesNotExist(key:)",
478478
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/doesNotMatchKeyInQuery(key:queryKey:query:)",
479-
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:object:usingEqComparator:)",
480-
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:value:usingEqComparator:)",
479+
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:object:)",
480+
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:value:)",
481+
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalToNoComparator(key:object:)",
482+
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalToNoComparator(key:value:)",
481483
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/exists(key:)",
482484
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/geoPoint(_:within:)-41yaf",
483485
"doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/geoPoint(_:within:)-9uzx1",
@@ -7768,7 +7770,7 @@
77687770
"type" : "topic",
77697771
"url" : "\/documentation\/parseswift\/doesnotmatchkeyinquery(key:querykey:query:)"
77707772
},
7771-
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/equalTo(key:object:usingEqComparator:)": {
7773+
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/equalTo(key:object:)": {
77727774
"abstract" : [
77737775
{
77747776
"text" : "Add a constraint that requires that a key is equal to a ",
@@ -7835,55 +7837,125 @@
78357837
},
78367838
{
78377839
"kind" : "typeIdentifier",
7838-
"preciseIdentifier" : "s:10ParseSwift7equalTo3key6object17usingEqComparatorAA15QueryConstraintVSS_xSbtKAA0A6ObjectRzlF1TL_xmfp",
7840+
"preciseIdentifier" : "s:10ParseSwift7equalTo3key6objectAA15QueryConstraintVSS_xtKAA0A6ObjectRzlF1TL_xmfp",
78397841
"text" : "T"
78407842
},
78417843
{
78427844
"kind" : "text",
7843-
"text" : ", "
7845+
"text" : ") "
7846+
},
7847+
{
7848+
"kind" : "keyword",
7849+
"text" : "throws"
7850+
},
7851+
{
7852+
"kind" : "text",
7853+
"text" : " -> "
7854+
},
7855+
{
7856+
"kind" : "typeIdentifier",
7857+
"preciseIdentifier" : "s:10ParseSwift15QueryConstraintV",
7858+
"text" : "QueryConstraint"
7859+
}
7860+
],
7861+
"identifier" : "doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:object:)",
7862+
"kind" : "symbol",
7863+
"role" : "symbol",
7864+
"title" : "equalTo(key:object:)",
7865+
"type" : "topic",
7866+
"url" : "\/documentation\/parseswift\/equalto(key:object:)"
7867+
},
7868+
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/equalTo(key:value:)": {
7869+
"abstract" : [
7870+
{
7871+
"text" : "Add a constraint that requires that a key is equal to a value.",
7872+
"type" : "text"
7873+
}
7874+
],
7875+
"fragments" : [
7876+
{
7877+
"kind" : "keyword",
7878+
"text" : "func"
7879+
},
7880+
{
7881+
"kind" : "text",
7882+
"text" : " "
7883+
},
7884+
{
7885+
"kind" : "identifier",
7886+
"text" : "equalTo"
7887+
},
7888+
{
7889+
"kind" : "text",
7890+
"text" : "<"
7891+
},
7892+
{
7893+
"kind" : "genericParameter",
7894+
"text" : "T"
7895+
},
7896+
{
7897+
"kind" : "text",
7898+
"text" : ">("
78447899
},
78457900
{
78467901
"kind" : "externalParam",
7847-
"text" : "usingEqComparator"
7902+
"text" : "key"
78487903
},
78497904
{
78507905
"kind" : "text",
78517906
"text" : ": "
78527907
},
78537908
{
78547909
"kind" : "typeIdentifier",
7855-
"preciseIdentifier" : "s:Sb",
7856-
"text" : "Bool"
7910+
"preciseIdentifier" : "s:SS",
7911+
"text" : "String"
78577912
},
78587913
{
78597914
"kind" : "text",
7860-
"text" : ") "
7915+
"text" : ", "
78617916
},
78627917
{
7863-
"kind" : "keyword",
7864-
"text" : "throws"
7918+
"kind" : "externalParam",
7919+
"text" : "value"
78657920
},
78667921
{
78677922
"kind" : "text",
7868-
"text" : " -> "
7923+
"text" : ": "
7924+
},
7925+
{
7926+
"kind" : "typeIdentifier",
7927+
"preciseIdentifier" : "s:10ParseSwift7equalTo3key5valueAA15QueryConstraintVSS_xtSeRzSERzlF1TL_xmfp",
7928+
"text" : "T"
7929+
},
7930+
{
7931+
"kind" : "text",
7932+
"text" : ") -> "
78697933
},
78707934
{
78717935
"kind" : "typeIdentifier",
78727936
"preciseIdentifier" : "s:10ParseSwift15QueryConstraintV",
78737937
"text" : "QueryConstraint"
78747938
}
78757939
],
7876-
"identifier" : "doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:object:usingEqComparator:)",
7940+
"identifier" : "doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:value:)",
78777941
"kind" : "symbol",
78787942
"role" : "symbol",
7879-
"title" : "equalTo(key:object:usingEqComparator:)",
7943+
"title" : "equalTo(key:value:)",
78807944
"type" : "topic",
7881-
"url" : "\/documentation\/parseswift\/equalto(key:object:usingeqcomparator:)"
7945+
"url" : "\/documentation\/parseswift\/equalto(key:value:)"
78827946
},
7883-
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/equalTo(key:value:usingEqComparator:)": {
7947+
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/equalToNoComparator(key:object:)": {
78847948
"abstract" : [
78857949
{
7886-
"text" : "Add a constraint that requires that a key is equal to a value.",
7950+
"text" : "Add a constraint that requires that a key is equal to a ",
7951+
"type" : "text"
7952+
},
7953+
{
7954+
"code" : "ParseObject",
7955+
"type" : "codeVoice"
7956+
},
7957+
{
7958+
"text" : ".",
78877959
"type" : "text"
78887960
}
78897961
],
@@ -7898,7 +7970,7 @@
78987970
},
78997971
{
79007972
"kind" : "identifier",
7901-
"text" : "equalTo"
7973+
"text" : "equalToNoComparator"
79027974
},
79037975
{
79047976
"kind" : "text",
@@ -7931,33 +8003,103 @@
79318003
},
79328004
{
79338005
"kind" : "externalParam",
7934-
"text" : "value"
8006+
"text" : "object"
79358007
},
79368008
{
79378009
"kind" : "text",
79388010
"text" : ": "
79398011
},
79408012
{
79418013
"kind" : "typeIdentifier",
7942-
"preciseIdentifier" : "s:10ParseSwift7equalTo3key5value17usingEqComparatorAA15QueryConstraintVSS_xSbtSeRzSERzlF1TL_xmfp",
8014+
"preciseIdentifier" : "s:10ParseSwift19equalToNoComparator3key6objectAA15QueryConstraintVSS_xtKAA0A6ObjectRzlF1TL_xmfp",
79438015
"text" : "T"
79448016
},
8017+
{
8018+
"kind" : "text",
8019+
"text" : ") "
8020+
},
8021+
{
8022+
"kind" : "keyword",
8023+
"text" : "throws"
8024+
},
8025+
{
8026+
"kind" : "text",
8027+
"text" : " -> "
8028+
},
8029+
{
8030+
"kind" : "typeIdentifier",
8031+
"preciseIdentifier" : "s:10ParseSwift15QueryConstraintV",
8032+
"text" : "QueryConstraint"
8033+
}
8034+
],
8035+
"identifier" : "doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalToNoComparator(key:object:)",
8036+
"kind" : "symbol",
8037+
"role" : "symbol",
8038+
"title" : "equalToNoComparator(key:object:)",
8039+
"type" : "topic",
8040+
"url" : "\/documentation\/parseswift\/equaltonocomparator(key:object:)"
8041+
},
8042+
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/equalToNoComparator(key:value:)": {
8043+
"abstract" : [
8044+
{
8045+
"text" : "Add a constraint that requires that a key is equal to a value.",
8046+
"type" : "text"
8047+
}
8048+
],
8049+
"fragments" : [
8050+
{
8051+
"kind" : "keyword",
8052+
"text" : "func"
8053+
},
8054+
{
8055+
"kind" : "text",
8056+
"text" : " "
8057+
},
8058+
{
8059+
"kind" : "identifier",
8060+
"text" : "equalToNoComparator"
8061+
},
8062+
{
8063+
"kind" : "text",
8064+
"text" : "<"
8065+
},
8066+
{
8067+
"kind" : "genericParameter",
8068+
"text" : "T"
8069+
},
8070+
{
8071+
"kind" : "text",
8072+
"text" : ">("
8073+
},
8074+
{
8075+
"kind" : "externalParam",
8076+
"text" : "key"
8077+
},
8078+
{
8079+
"kind" : "text",
8080+
"text" : ": "
8081+
},
8082+
{
8083+
"kind" : "typeIdentifier",
8084+
"preciseIdentifier" : "s:SS",
8085+
"text" : "String"
8086+
},
79458087
{
79468088
"kind" : "text",
79478089
"text" : ", "
79488090
},
79498091
{
79508092
"kind" : "externalParam",
7951-
"text" : "usingEqComparator"
8093+
"text" : "value"
79528094
},
79538095
{
79548096
"kind" : "text",
79558097
"text" : ": "
79568098
},
79578099
{
79588100
"kind" : "typeIdentifier",
7959-
"preciseIdentifier" : "s:Sb",
7960-
"text" : "Bool"
8101+
"preciseIdentifier" : "s:10ParseSwift19equalToNoComparator3key5valueAA15QueryConstraintVSS_xtSeRzSERzlF1TL_xmfp",
8102+
"text" : "T"
79618103
},
79628104
{
79638105
"kind" : "text",
@@ -7969,12 +8111,12 @@
79698111
"text" : "QueryConstraint"
79708112
}
79718113
],
7972-
"identifier" : "doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalTo(key:value:usingEqComparator:)",
8114+
"identifier" : "doc:\/\/edu.uky.cs.netreconlab.ParseSwift\/documentation\/ParseSwift\/equalToNoComparator(key:value:)",
79738115
"kind" : "symbol",
79748116
"role" : "symbol",
7975-
"title" : "equalTo(key:value:usingEqComparator:)",
8117+
"title" : "equalToNoComparator(key:value:)",
79768118
"type" : "topic",
7977-
"url" : "\/documentation\/parseswift\/equalto(key:value:usingeqcomparator:)"
8119+
"url" : "\/documentation\/parseswift\/equaltonocomparator(key:value:)"
79788120
},
79798121
"doc://edu.uky.cs.netreconlab.ParseSwift/documentation/ParseSwift/exists(key:)": {
79808122
"abstract" : [

‎release/data/documentation/parseswift/==(_:_:)-5jg5t.json

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,27 +298,67 @@
298298
"type" : "text"
299299
},
300300
{
301-
"text" : "Behavior changes based on ",
301+
"text" : "This method uses ",
302302
"type" : "text"
303303
},
304304
{
305-
"code" : "ParseSwift.configuration.isUsingEqualQueryConstraint",
305+
"code" : "$eq",
306306
"type" : "codeVoice"
307307
},
308+
{
309+
"text" : " and can",
310+
"type" : "text"
311+
},
312+
{
313+
"text" : " ",
314+
"type" : "text"
315+
},
316+
{
317+
"text" : "be combined with all other ",
318+
"type" : "text"
319+
},
320+
{
321+
"code" : "QueryConstaint",
322+
"type" : "codeVoice"
323+
},
324+
{
325+
"text" : "’s. It has the limitation of",
326+
"type" : "text"
327+
},
308328
{
309329
"text" : " ",
310330
"type" : "text"
311331
},
312332
{
313-
"text" : "where isUsingEqualQueryConstraint == true is known not to work for LiveQuery on",
333+
"text" : "not to working for LiveQuery on Parse Servers ",
314334
"type" : "text"
315335
},
336+
{
337+
"code" : "< 6.3.0",
338+
"type" : "codeVoice"
339+
},
340+
{
341+
"text" : ". If you are using",
342+
"type" : "text"
343+
},
344+
{
345+
"text" : " ",
346+
"type" : "text"
347+
},
348+
{
349+
"text" : "an older Parse Server, you should use ",
350+
"type" : "text"
351+
},
352+
{
353+
"code" : "equalToNoComparator()",
354+
"type" : "codeVoice"
355+
},
316356
{
317357
"text" : " ",
318358
"type" : "text"
319359
},
320360
{
321-
"text" : "Parse Servers <= 5.0.0.",
361+
"text" : "instead.",
322362
"type" : "text"
323363
}
324364
],

0 commit comments

Comments
 (0)