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

6
frontend/document/credocument.lua
View File

@@ -366,7 +366,7 @@ function CreDocument:drawCurrentView(target, x, y, rect, pos)
-- to match the screen's BB type, allowing us to take shortcuts when blitting.
self.buffer = Blitbuffer.new(rect.w, rect.h, self.render_color and Blitbuffer.TYPE_BBRGB32 or nil)
end
-- TODO: self.buffer could be re-used when no page/layout/highlights
--- @todo self.buffer could be re-used when no page/layout/highlights
-- change has been made, to avoid having crengine redraw the exact
-- same buffer. And it could only change when some other methods
-- from here are called
@@ -714,7 +714,7 @@ function CreDocument:setStyleSheet(new_css_file, appended_css_content )
end
function CreDocument:setEmbeddedStyleSheet(toggle)
-- FIXME: occasional segmentation fault when switching embedded style sheet
--- @fixme occasional segmentation fault when switching embedded style sheet
logger.dbg("CreDocument: set embedded style sheet", toggle)
self._document:setIntProperty("crengine.doc.embedded.styles.enabled", toggle)
end
@@ -748,7 +748,7 @@ function CreDocument:setNightmodeImages(toggle)
end
function CreDocument:setFloatingPunctuation(enabled)
-- FIXME: occasional segmentation fault when toggling floating punctuation
--- @fixme occasional segmentation fault when toggling floating punctuation
logger.dbg("CreDocument: set floating punctuation", enabled)
self._document:setIntProperty("crengine.style.floating.punctuation.enabled", enabled)
end