2020-01-17 20:00:42 +01:00
|
|
|
-- Configuration file for ldoc
|
|
|
|
|
|
2024-10-31 21:18:37 +01:00
|
|
|
project = "battery_widget"
|
|
|
|
|
title = "A UPowerGlib based battery widget for the Awesome WM with a basic widget template mechanism! 🔋"
|
2020-01-17 20:00:42 +01:00
|
|
|
|
|
|
|
|
all = false
|
2024-10-31 21:18:37 +01:00
|
|
|
dir = "doc"
|
|
|
|
|
format = "markdown"
|
|
|
|
|
pretty = "lua"
|
2020-01-17 20:00:42 +01:00
|
|
|
prettify_files = true
|
|
|
|
|
backtick_references = true
|
|
|
|
|
merge = true
|
|
|
|
|
use_markdown_titles = true
|
|
|
|
|
wrap = true
|
|
|
|
|
sort_modules = true
|
|
|
|
|
not_luadoc = true
|
|
|
|
|
|
|
|
|
|
-- Define some new ldoc tags from the AwesomeWM doc
|
|
|
|
|
new_type("staticfct", "Static functions", false, "Parameters")
|
|
|
|
|
new_type("constructorfct", "Constructor", false, "Parameters")
|
|
|
|
|
new_type("method", "Object methods", false, "Parameters")
|
|
|
|
|
new_type("property", "Object properties", false, "Type")
|
|
|
|
|
new_type("signal", "Signals", false, "Arguments")
|
