Skip to content

Commit 4bd452e

Browse files
authored
Update function.xml
Correction of spldoc format: replaced {_1} by \{_1\}
1 parent a32035c commit 4bd452e

File tree

1 file changed

+18
-18
lines changed
  • com.ibm.streamsx.json/com.ibm.streamsx.json/native.function

1 file changed

+18
-18
lines changed

com.ibm.streamsx.json/com.ibm.streamsx.json/native.function/function.xml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Parse JSON string (used in conjunction with queryJSON function).
4444
Threading limitations:
4545
Call to parseJSON should not be placed in param section or state of the operator (internally a json object is shared via the thread local storage).
4646
@param jsonString The input JSON string.
47-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
47+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
4848
@return Error code (0 - no error).
4949
</function:description>
5050
<function:prototype>&lt;enum E> public uint32 parseJSON(rstring jsonString, E jsonIndex)</function:prototype>
@@ -56,7 +56,7 @@ Threading limitations:
5656
Call to queryJSON should not be placed in param section or state of the operator (internally a json object is shared via the thread local storage).
5757
@param jsonPath Path to a JSON attribute.
5858
@param defaultVal Default value to apply when an attribute not found.
59-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
59+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
6060
@return JSON value.
6161
</function:description>
6262
<function:prototype>&lt;enum E> public boolean queryJSON(rstring jsonPath, boolean defaultVal, E jsonIndex)</function:prototype>
@@ -67,7 +67,7 @@ Query JSON object value with a given path (parseJSON function should be run befo
6767
@param jsonPath Path to a JSON attribute.
6868
@param defaultVal Default value to apply when an attribute not found.
6969
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
70-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
70+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
7171
@return JSON value.
7272
</function:description>
7373
<function:prototype>&lt;enum E> public boolean queryJSON(rstring jsonPath, boolean defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -77,7 +77,7 @@ Query JSON object value with a given path (parseJSON function should be run befo
7777
Query JSON object for integral value with a given path (parseJSON function should be run before).
7878
@param jsonPath Path to a JSON attribute.
7979
@param defaultVal Default value to apply when an attribute not found.
80-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
80+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
8181
@return JSON value.
8282
</function:description>
8383
<function:prototype>&lt;integral T, enum E> public T queryJSON(rstring jsonPath, T defaultVal, E jsonIndex)</function:prototype>
@@ -88,7 +88,7 @@ Query JSON object for integral value with a given path (parseJSON function shoul
8888
@param jsonPath Path to a JSON attribute.
8989
@param defaultVal Default value to apply when an attribute not found.
9090
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
91-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
91+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
9292
@return JSON value.
9393
</function:description>
9494
<function:prototype>&lt;integral T, enum E> public T queryJSON(rstring jsonPath, T defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -98,7 +98,7 @@ Query JSON object for integral value with a given path (parseJSON function shoul
9898
Query JSON object for floatingpoint value with a given path (parseJSON function should be run before).
9999
@param jsonPath Path to a JSON attribute.
100100
@param defaultVal Default value to apply when an attribute not found.
101-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
101+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
102102
@return JSON value.
103103
</function:description>
104104
<function:prototype>&lt;floatingpoint T, enum E> public T queryJSON(rstring jsonPath, T defaultVal, E jsonIndex)</function:prototype>
@@ -109,7 +109,7 @@ Query JSON object for floatingpoint value with a given path (parseJSON function
109109
@param jsonPath Path to a JSON attribute.
110110
@param defaultVal Default value to apply when an attribute not found.
111111
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
112-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
112+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
113113
@return JSON value.
114114
</function:description>
115115
<function:prototype>&lt;floatingpoint T, enum E> public T queryJSON(rstring jsonPath, T defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -119,7 +119,7 @@ Query JSON object for floatingpoint value with a given path (parseJSON function
119119
Query JSON object for string value with a given path (parseJSON function should be run before).
120120
@param jsonPath Path to a JSON attribute.
121121
@param defaultVal Default value to apply when an attribute not found.
122-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
122+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
123123
@return JSON value.
124124
</function:description>
125125
<function:prototype>&lt;string T, enum E> public T queryJSON(rstring jsonPath, T defaultVal, E jsonIndex)</function:prototype>
@@ -130,7 +130,7 @@ Query JSON object for string value with a given path (parseJSON function should
130130
@param jsonPath Path to a JSON attribute.
131131
@param defaultVal Default value to apply when an attribute not found.
132132
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
133-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
133+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
134134
@return JSON value.
135135
</function:description>
136136
<function:prototype>&lt;string T, enum E> public T queryJSON(rstring jsonPath, T defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -140,7 +140,7 @@ Query JSON object for string value with a given path (parseJSON function should
140140
Query JSON object for list of booleans with a given path (parseJSON function should be run before).
141141
@param jsonPath Path to a JSON attribute.
142142
@param defaultVal Default value to apply when an attribute not found.
143-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
143+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
144144
@return JSON value.
145145
</function:description>
146146
<function:prototype>&lt;enum E> public list&lt;boolean> queryJSON(rstring jsonPath, list&lt;boolean> defaultVal, E jsonIndex)</function:prototype>
@@ -151,7 +151,7 @@ Query JSON object for list of booleans with a given path (parseJSON function sho
151151
@param jsonPath Path to a JSON attribute.
152152
@param defaultVal Default value to apply when an attribute not found.
153153
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
154-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
154+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
155155
@return JSON value.
156156
</function:description>
157157
<function:prototype>&lt;enum E> public list&lt;boolean> queryJSON(rstring jsonPath, list&lt;boolean> defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -161,7 +161,7 @@ Query JSON object for list of booleans with a given path (parseJSON function sho
161161
Query JSON object for list of integrals with a given path (parseJSON function should be run before).
162162
@param jsonPath Path to a JSON attribute.
163163
@param defaultVal Default value to apply when an attribute not found.
164-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
164+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
165165
@return JSON value.
166166
</function:description>
167167
<function:prototype>&lt;integral T, enum E> public list&lt;T> queryJSON(rstring jsonPath, list&lt;T> defaultVal, E jsonIndex)</function:prototype>
@@ -172,7 +172,7 @@ Query JSON object for list of integrals with a given path (parseJSON function sh
172172
@param jsonPath Path to a JSON attribute.
173173
@param defaultVal Default value to apply when an attribute not found.
174174
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
175-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
175+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
176176
@return JSON value.
177177
</function:description>
178178
<function:prototype>&lt;integral T, enum E> public list&lt;T> queryJSON(rstring jsonPath, list&lt;T> defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -182,7 +182,7 @@ Query JSON object for list of integrals with a given path (parseJSON function sh
182182
Query JSON object for list of floatingpoint values with a given path (parseJSON function should be run before).
183183
@param jsonPath Path to a JSON attribute.
184184
@param defaultVal Default value to apply when an attribute not found.
185-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
185+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
186186
@return JSON value.
187187
</function:description>
188188
<function:prototype>&lt;floatingpoint T, enum E> public list&lt;T> queryJSON(rstring jsonPath, list&lt;T> defaultVal, E jsonIndex)</function:prototype>
@@ -193,7 +193,7 @@ Query JSON object for list of floatingpoint values with a given path (parseJSON
193193
@param jsonPath Path to a JSON attribute.
194194
@param defaultVal Default value to apply when an attribute not found.
195195
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
196-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
196+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
197197
@return JSON value.
198198
</function:description>
199199
<function:prototype>&lt;floatingpoint T, enum E> public list&lt;T> queryJSON(rstring jsonPath, list&lt;T> defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -203,7 +203,7 @@ Query JSON object for list of floatingpoint values with a given path (parseJSON
203203
Query JSON object for list of strings with a given path (parseJSON function should be run before).
204204
@param jsonPath Path to a JSON attribute.
205205
@param defaultVal Default value to apply when an attribute not found.
206-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
206+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
207207
@return JSON value.
208208
</function:description>
209209
<function:prototype>&lt;string T, enum E> public list&lt;T> queryJSON(rstring jsonPath, list&lt;T> defaultVal, E jsonIndex)</function:prototype>
@@ -214,7 +214,7 @@ Query JSON object for list of strings with a given path (parseJSON function shou
214214
@param jsonPath Path to a JSON attribute.
215215
@param defaultVal Default value to apply when an attribute not found.
216216
@param status indicates a status of the query (0: found - type matched, 1: found - type did not matched, 2: found - value is null, 3: not found).
217-
@param jsonIndex Json index of enum type (e.g. enum{_1}).
217+
@param jsonIndex Json index of enum type (e.g. enum\{_1\}).
218218
@return JSON value.
219219
</function:description>
220220
<function:prototype>&lt;string T, enum E> public list&lt;T> queryJSON(rstring jsonPath, list&lt;T> defaultVal, mutable enum{FOUND, FOUND_CAST, FOUND_WRONG_TYPE, FOUND_NULL, NOT_FOUND} status, E jsonIndex)</function:prototype>
@@ -229,4 +229,4 @@ Query JSON object for list of strings with a given path (parseJSON function shou
229229
</function:library>
230230
</function:dependencies>
231231
</function:functionSet>
232-
</function:functionModel>
232+
</function:functionModel>

0 commit comments

Comments
 (0)