added clear deprecated message to every @deprecated definition

usethesource · May 10, 2024 · 5605bcd · 5605bcd
1 parent 37ad8ed
commit 5605bcd
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/src/lang/rascal/tutor/apidoc/ExtractInfo.rsc b/src/lang/rascal/tutor/apidoc/ExtractInfo.rsc
@@ -171,15 +171,27 @@ str getSynopsis(rel[str, DocTag] tags) {
     }
 
     if (docTag(content=str docContents) <- tags["synopsis"]) {
-      return trim(intercalate(" ", split("\n", docContents)));
+      if (docTag(content=str deprMessage) <- tags["deprecated"]) {
+        return "<trim(intercalate(" ", split("\n", docContents)))>
+               '
+               ':::warning
+               '**deprecated: marked for future deletion**
+               '<deprMessage>
+               '::: 
+               '";
+      }
+      else {
+        return trim(intercalate(" ", split("\n", docContents)));
+      }
+      
     }
     else {
       return "";
     }
 }
 
 
-bool isTutorTag(str label) = label in {"doc", "synopsis", "syntax", "types", "details", "description", "examples", "benefits", "pitfalls"};
+bool isTutorTag(str label) = label in {"doc", "synopsis", "syntax", "types", "details", "description", "examples", "benefits", "pitfalls", "deprecated"};
 
 @synopsis{extracts the contents of _all_ tags from a declaration syntax tree and stores origin information}
 rel[str, DocTag] getTagContents(Tags tags){