diff --git a/CMakeLists.txt b/CMakeLists.txt index 26d5ebad1..ed9a35b14 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -286,9 +286,6 @@ if(GENERATE_DOC) # Copy the images to the build directory file(COPY ${SOURCE_DIR}/docs/images DESTINATION ${BUILD_DIR}/doc) - # Copy the aliases to the build directory - file(COPY ${SOURCE_DIR}/docs/aliases DESTINATION ${BUILD_DIR}/docs) - # Copy ldoc files. configure_file(${SOURCE_DIR}/docs/ldoc.css ${BUILD_DIR}/docs COPYONLY) configure_file(${SOURCE_DIR}/docs/ldoc.ltp ${BUILD_DIR}/docs COPYONLY) diff --git a/docs/aliases/awful_client.lua b/docs/aliases/awful_client.lua deleted file mode 100644 index 24ff923dd..000000000 --- a/docs/aliases/awful_client.lua +++ /dev/null @@ -1,5 +0,0 @@ ---------------------------------------------------------------------------- ---- This module documentation has been merged with the `client` class. --- --- @module awful.client ---------------------------------------------------------------------------- diff --git a/docs/aliases/awful_mouse.lua b/docs/aliases/awful_mouse.lua deleted file mode 100644 index efdb1a07c..000000000 --- a/docs/aliases/awful_mouse.lua +++ /dev/null @@ -1,5 +0,0 @@ ---------------------------------------------------------------------------- ---- This module documentation has been merged with the `mouse` class. --- --- @module awful.mouse ---------------------------------------------------------------------------- diff --git a/docs/aliases/awful_screen.lua b/docs/aliases/awful_screen.lua deleted file mode 100644 index 755b6a019..000000000 --- a/docs/aliases/awful_screen.lua +++ /dev/null @@ -1,5 +0,0 @@ ---------------------------------------------------------------------------- ---- This module documentation has been merged with the `screen` class. --- --- @module awful.screen ---------------------------------------------------------------------------- diff --git a/docs/aliases/awful_tag.lua b/docs/aliases/awful_tag.lua deleted file mode 100644 index ee7887e36..000000000 --- a/docs/aliases/awful_tag.lua +++ /dev/null @@ -1,5 +0,0 @@ ---------------------------------------------------------------------------- ---- This module documentation has been merged with the `tag` class. --- --- @module awful.tag ---------------------------------------------------------------------------- diff --git a/docs/common/rules_index.ldoc b/docs/common/rules_index.ldoc index ac75c08ca..181a7028a 100644 --- a/docs/common/rules_index.ldoc +++ b/docs/common/rules_index.ldoc @@ -15,8 +15,8 @@ -- callbackA function to call when this client is ready -- markedIf a client is marked or not -- is\_fixedReturn if a client has a fixed size or not --- immobilizedIs the client immobilized horizontally? --- immobilizedIs the client immobilized vertically? +-- immobilized\_horizontalIs the client immobilized horizontally? +-- immobilized\_verticalIs the client immobilized vertically? -- floatingThe client floating state -- xThe x coordinates -- yThe y coordinates diff --git a/docs/config.ld b/docs/config.ld index dc244ae2a..75892c65c 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -121,11 +121,6 @@ file = { '../lib/', -- Auto generated scripts '../script_files/', - -- Old APIs the user should not longer use directly - '../docs/aliases/awful_client.lua', - '../docs/aliases/awful_screen.lua', - '../docs/aliases/awful_tag.lua', - '../docs/aliases/awful_mouse.lua', exclude = { -- exclude these modules, as they do not contain any written -- documentation @@ -149,6 +144,8 @@ file = { -- in the index '../lib/awful/widget/graph.lua', '../lib/awful/widget/progressbar.lua', + '../lib/awful/widget/textclock.lua', + '../lib/awful/wibox.lua', '../lib/wibox/layout/constraint.lua', '../lib/wibox/layout/margin.lua', '../lib/wibox/layout/mirror.lua', @@ -163,6 +160,14 @@ local no_prefix = { deprecatedproperty = true, } +-- These modules merge the doc of their `awful` siblings. +local coreclassmap = { + tag = "tag and awful.tag", + screen = "screen and awful.screen", + client = "client and awful.client", + mouse = "mouse and awful.mouse", +} + custom_display_name_handler = function(item, default_handler) -- Remove the "namespace" from the signals and properties if no_prefix[item.type] then @@ -170,6 +175,11 @@ custom_display_name_handler = function(item, default_handler) return name ~= "" and name or item.name end + -- Handle the left sidebar modules. + if item.type == "coreclassmod" and coreclassmap[item.name] then + return coreclassmap[item.name] + end + if item.type == "deprecated" or item.type == "deprecatedproperty" then return default_handler(item) .. " [deprecated]" end diff --git a/docs/ldoc.css b/docs/ldoc.css index a761088f6..db42a48e3 100644 --- a/docs/ldoc.css +++ b/docs/ldoc.css @@ -355,6 +355,12 @@ a:target + * { background-color: #FF9; } +/* tag + awful.tag */ +.listplusign { + color: #b7c1ff; + text-decoration: underline; + text-decoration-color: white; +} /* styles for prettification of source */ pre .comment { color: #bbccaa; }