renun/koreader
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-08-10 00:52:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
frontend/ui/message/filemessagequeue.lua
View File

@@ -16,10 +16,10 @@ function FileMessageQueue:init()
self.filemq = self.client
self.poller = czmq.zpoller_new(filemq.fmq_client_handle(self.client), nil)
elseif self.server ~= nil then
-- TODO: currently fmq_server_recv API is not available
--- @todo currently fmq_server_recv API is not available
--self.fmq_recv = filemq.fmq_server_recv
self.filemq = self.server
-- TODO: currently fmq_server_handle API is not available
--- @todo currently fmq_server_handle API is not available
--self.poller = czmq.zpoller_new(filemq.fmq_server_handle(self.server), nil)
end
end