awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc: Add a deprecated property section.

This commit is contained in:
Emmanuel Lepage Vallee 2019-03-12 14:36:32 -04:00
parent 68f6a567d1
commit 50d4e8f04b
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/config.ld
View File

@ -53,6 +53,8 @@ tparam_alias('screen_or_idx', 'screen|int')
new_type("function", "Functions") new_type("function", "Functions")
-- Documentation for objects properties -- Documentation for objects properties
new_type("property", "Object properties", false, "Type") new_type("property", "Object properties", false, "Type")
-- Documentation for objects deprecated properties
new_type("deprecatedproperty", "Deprecated object properties", false, "Type")
-- New type for signals -- New type for signals
new_type("signal", "Signals", false, "Arguments") new_type("signal", "Signals", false, "Arguments")
-- New type for signals connections -- New type for signals connections
@ -142,7 +144,8 @@ file = {
} }
local no_prefix = { local no_prefix = {
property = true, signal = true, clientruleproperty = true property = true, signal = true, clientruleproperty = true,
deprecatedproperty = true,
} }
custom_display_name_handler = function(item, default_handler) custom_display_name_handler = function(item, default_handler)
@ -153,7 +156,7 @@ custom_display_name_handler = function(item, default_handler)
return name ~= "" and name or item.name return name ~= "" and name or item.name
end end
if item.type == "deprecated" then if item.type == "deprecated" or item.type == "deprecatedproperty" then
return default_handler(item) .. "</a> <i class=\"deprecated_label\">[deprecated]</i><a>" return default_handler(item) .. "</a> <i class=\"deprecated_label\">[deprecated]</i><a>"
end end