[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

@@ -182,7 +182,7 @@ function ReaderPaging:onReadSettings(config)
end
function ReaderPaging:onSaveSettings()
-- TODO: only save current_page page position
--- @todo only save current_page page position
self.ui.doc_settings:saveSetting("page_positions", self.page_positions)
self.ui.doc_settings:saveSetting("last_page", self:getTopPage())
self.ui.doc_settings:saveSetting("percent_finished", self:getLastPercent())
@@ -203,7 +203,7 @@ function ReaderPaging:getLastPercent()
end
function ReaderPaging:addToMainMenu(menu_items)
-- FIXME: repeated code with page overlap menu for readerrolling
--- @fixme repeated code with page overlap menu for readerrolling
-- needs to keep only one copy of the logic as for the DRY principle.
-- The difference between the two menus is only the enabled func.
local page_overlap_menu = {