2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
koreader/doc/config.ld
Frans de Jonge a2dcfe9aec
[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
2019-08-23 19:53:53 +02:00

26 lines
682 B
Plaintext

project = 'KOReader'
description = 'Multi-platform ebook reader'
full_description = 'An ebook reader application supports PDF, DJVU, EPUB, FB2 and many more formats, running on Kindle, Kobo, PocketBook, Ubuntu Touch and Android devices.'
title = 'KOReader Documentation'
dir = 'html'
style = '!fixed'
use_markdown_titles = true
topics = {
'../README.md',
'./Collaborating_with_Git.md',
'./DataStore.md',
'./Development_guide.md',
'./Events.md',
'./Hacking.md',
'./Porting.md',
'./Unit_tests.md',
}
package = ''
format = 'markdown'
sort_modules = true
file = {
'../frontend',
'../base/ffi',
'../platform/android/luajit-launcher/assets',
}