Add @deprecated tag to relevant functions

anet-be · Jul 22, 2024 · dbb4eb3 · dbb4eb3
1 parent 9f72c5a
commit dbb4eb3
Show file tree

Hide file tree

Showing 6 changed files with 147 additions and 31 deletions.
diff --git a/docs/config/main.ld b/docs/config/main.ld
@@ -14,5 +14,16 @@ sort = true
 --readme = 'README.md' -- ldoc's rendering isn't very pretty so instead link to README.md on github
 --examples = 'examples'  -- ldoc doesn't support .ci and .m files so examples are instead links to github
 
+-- format @deprecated tag
+custom_display_name_handler = function(item, default_handler)
+  if item.tags.deprecated then
+    return default_handler(item) .. ('  [deprecated %s]:'):format(item.tags.deprecated[1])
+  end
+  return default_handler(item)
+end
+
 alias('example', 'usage')
-custom_tags = {{'invocation', title='Invocation', hidden=true}}
+custom_tags = {
+    {'invocation', title='Invocation', hidden=true},
+    {'deprecated', title='Deprecated', hidden=true},
+}
diff --git a/docs/config/private.ld b/docs/config/private.ld
@@ -15,5 +15,16 @@ merge = true
 --readme = 'README.md' -- ldoc's rendering isn't very pretty so instead link to README.md on github
 --examples = 'examples'  -- ldoc doesn't support .ci and .m files so examples are instead links to github
 
+-- format @deprecated tag
+custom_display_name_handler = function(item, default_handler)
+  if item.tags.deprecated then
+    return default_handler(item) .. ('  [deprecated %s]:'):format(item.tags.deprecated[1])
+  end
+  return default_handler(item)
+end
+
 alias('example', 'usage')
-custom_tags = {{'invocation', title='Invocation', hidden=true}}
+custom_tags = {
+    {'invocation', title='Invocation', hidden=true},
+    {'deprecated', title='Deprecated', hidden=true},
+}
diff --git a/docs/config/ydb.ld b/docs/config/ydb.ld
@@ -15,5 +15,16 @@ backtick_references = true
 format = 'markdown'
 sort = true
 
+-- format @deprecated tag
+custom_display_name_handler = function(item, default_handler)
+  if item.tags.deprecated then
+    return default_handler(item) .. ('  [deprecated %s]:'):format(item.tags.deprecated[1])
+  end
+  return default_handler(item)
+end
+
 alias('example', 'usage')
-custom_tags = {{'invocation', title='Invocation', hidden=true}}
+custom_tags = {
+    {'invocation', title='Invocation', hidden=true},
+    {'deprecated', title='Deprecated', hidden=true},
+}