fix: Add deprecation warnings to markdown docs

rdkcentral · Oct 23, 2024 · d5ebc27 · d5ebc27
1 parent 022363b
commit d5ebc27
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/languages/markdown/templates/methods/default.md b/languages/markdown/templates/methods/default.md
@@ -1,5 +1,12 @@
 ### ${method.name}
+${if.deprecated} 
+[Deprecated] This method is deprecated as of ${method.deprecation}. ${if.method.alternative}Please use `${method.alternative}` as a replacement.${end.if.method.alternative}
 
+```typescript
+${method.signature}
+```
+${end.if.deprecated}
+${if.not.deprecated}
 ${method.summary}
 
 ```typescript
@@ -17,5 +24,5 @@ ${method.capabilities}
 #### Examples
 
 ${method.examples}
-
+${end.if.not.deprecated}
 ---
diff --git a/languages/markdown/templates/methods/event.md b/languages/markdown/templates/methods/event.md
@@ -1,5 +1,11 @@
 ### ${event.name}
 
+${if.deprecated}
+[Deprecated] This method is deprecated as of ${method.deprecation}. ${if.method.alternative}Please use `${method.alternative}` as a replacement.${end.if.method.alternative}
+${end.if.deprecated}
+
+${if.not.deprecated}
+
 ```typescript
 function listen('${event.name}', ${event.signature.params}${if.context}, ${end.if.context}(${event.result.type}) => void): Promise<number>
 ```
@@ -16,5 +22,5 @@ ${method.capabilities}
 #### Examples
 
 ${method.examples}
-
+${end.if.not.deprecated}
 ---
diff --git a/languages/markdown/templates/schemas/schemas/index.md b/languages/markdown/templates/schemas/schemas/index.md
@@ -4,12 +4,8 @@ title: ${info.title}
 
 # ${info.title}
 ---
-Version ${info.version}
 
 ## Table of Contents
 ${toc}
 
-## Overview
- ${info.description}
-
 /* ${SCHEMAS} */
diff --git a/src/macrofier/engine.mjs b/src/macrofier/engine.mjs
@@ -1525,10 +1525,15 @@ function insertMethodMacros(template, methodObj, json, templates, type = '', exa
 
 
   if (method.deprecated) {
+    if (method.alternative) {
+      template = template.replace(/\$\{if\.method\.alternative\}(.*?)\$\{end\.if\.method\.alternative\}/gms, '$1')
+    }
     template = template.replace(/\$\{if\.deprecated\}(.*?)\$\{end\.if\.deprecated\}/gms, '$1')
+    template = template.replace(/\$\{if\.not\.deprecated\}(.*?)\$\{end\.if\.not\.deprecated\}/gms, '')
   }
   else {
     template = template.replace(/\$\{if\.deprecated\}(.*?)\$\{end\.if\.deprecated\}/gms, '')
+    template = template.replace(/\$\{if\.not\.deprecated\}(.*?)\$\{end\.if\.not\.deprecated\}/gms, '$1')
   }
 
   // method.params[n].xxx macros