From 1c11d5e6caecbaf42ae63d6097b6909b4655aabc Mon Sep 17 00:00:00 2001 From: "Jurgen J. Vinju" Date: Mon, 25 Nov 2024 19:56:36 +0100 Subject: [PATCH] added synopsis to old JSON IO functions such that they are documented and their deprecation is too --- src/org/rascalmpl/library/lang/json/IO.rsc | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/org/rascalmpl/library/lang/json/IO.rsc b/src/org/rascalmpl/library/lang/json/IO.rsc index 171c1c0aca0..bcf08efca99 100644 --- 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}