[doc] Tag @todo, @fixme and @warning (#5244)

This commit standardizes the various todos around the code a bit in a manner recognized by LDoc.

Besides drawing more attention by being displayed in the developer docs, they're also extractable with LDoc on the command line:

```sh
ldoc --tags todo,fixme *.lua
```

However, whether that particular usage offers any advantage over other search tools is questionable at best.

* and some random beautification
This commit is contained in:
Frans de Jonge
2019-08-23 19:53:53 +02:00
committed by GitHub
parent dc6d4085ea
commit a2dcfe9aec
68 changed files with 172 additions and 150 deletions

View File

@@ -346,7 +346,7 @@ function ReaderGesture:addToMainMenu(menu_items)
end
custom_multiswipes:addTableItem("multiswipes", recorded_multiswipe)
-- TODO implement some nicer method in TouchMenu than this ugly hack for updating the menu
--- @todo Implement some nicer method in TouchMenu than this ugly hack for updating the menu.
touchmenu_instance.item_table[3] = self:genMultiswipeSubmenu()
touchmenu_instance:updateItems()
UIManager:close(multiswipe_recorder)