added synopsis to old JSON IO functions such that they are documented…

… and their deprecation is too
usethesource · Nov 25, 2024 · 1c11d5e · 1c11d5e
1 parent 6996898
commit 1c11d5e
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/src/org/rascalmpl/library/lang/json/IO.rsc b/src/org/rascalmpl/library/lang/json/IO.rsc
@@ -15,15 +15,18 @@
 module lang::json::IO
 
 @javaClass{org.rascalmpl.library.lang.json.IO}
-@deprecated{use writeJSON}
+@synopsis{Maps any Rascal value to a JSON string}
+@deprecated{use ((writeJSON))}
 public java str toJSON(value v);
 
 @javaClass{org.rascalmpl.library.lang.json.IO}
-@deprecated{use asJSON}
+@synopsis{Maps any Rascal value to a JSON string, optionally in compact form.}
+@deprecated{use ((asJSON))}
 public java str toJSON(value v, bool compact);
 
 @javaClass{org.rascalmpl.library.lang.json.IO}
-@deprecated{use readJSON}
+@deprecated{use ((readJSON))}
+@synopsis{Parses a JSON string and maps it to the requested type of Rascal value.}
 public java &T fromJSON(type[&T] typ, str src);
 
 @javaClass{org.rascalmpl.library.lang.json.IO}