doc: Add more deprecation related tags.

They do nothing for now, but once we are done adding them to
everything, they will replace the old `@deprecated` family of
type-tags.

They carry more information such as when it was removed and why.
Cross-referenced with the @version, we can infer the deprecation
status based on the current release rather than a boolean
"deprecated or not deprecated".
This commit is contained in:
Emmanuel Lepage Vallee 2019-11-28 18:37:57 -05:00
parent ec7cac5dbf
commit 6f92f60076
1 changed files with 33 additions and 0 deletions

View File

@ -344,6 +344,39 @@ add_custom_tag {
hidden = true hidden = true
} }
-- Specify when this an item was deprecated.
-- @deprecatedin 4.4 Optional message.
add_custom_tag {
name = "deprecatedin",
hidden = true,
params = {
{ name = "api_level" },
},
}
-- Specify when this an item was deprecated because it was renamed.
-- @renamedin 4.4 new_name Optional message.
add_custom_tag {
name = "renamedin",
hidden = true,
params = {
{ name = "api_level" },
{ name = "new_name" },
},
}
-- Specify when this an item was deprecated because it was moved.
-- @movedin 4.4 new_class new_name Optional message.
add_custom_tag {
name = "movedin",
hidden = true,
params = {
{ name = "api_level" },
{ name = "new_class" },
{ name = "new_name" },
},
}
-- More fitting section names -- More fitting section names
kind_names={topic='Documentation', module='Libraries', script='Sample files'} kind_names={topic='Documentation', module='Libraries', script='Sample files'}