Commit Graph

30 Commits (4345201e0ea70ee8e3adf6c03e906ecf28e1bf75)

Author SHA1 Message Date
Frans de Jonge 090f33b5b8
[fix] Minor doc touchups re. QR encode (#6861)
Cf. <https://github.com/koreader/koreader/pull/6844#issuecomment-723672448>.
4 years ago
yparitcher 602e0b3feb ldoc fixes 4 years ago
NiLuJe f0f0cfd167
[Dev docs] Steer people more strongly towards koxtoolchain (#6727)
* Steer people more strongly towards koxtoolchain

And stop mentioning blatantly broken/outdated stuff

* Add macOS to the list

Also, put 'em in hierarchical order, and link to the main build docs for
the native emulator.
4 years ago
yparitcher 70f89c4df1
ReaderGesture: cleanup (#6292)
convert all gesture actions to use events for better modularity
add network event handlers and device event handlers
4 years ago
Martín Fernández f4dad2fae8
[doc] WSL extra bits (#6368)
Fixes #6354
4 years ago
Frans de Jonge f8af0a9e0e
[doc] Add some tips about GitHub PR refs (#6289) 4 years ago
Frans de Jonge 48060c3b86
[fix] Ignore sha2.lua in doc generation (#6229)
Otherwise it'll choke on the comments in that file.

See <https://github.com/koreader/koreader/pull/6195#issuecomment-638801075>.

Accidentally introduced in <https://github.com/koreader/koreader-base/pull/1105>.
4 years ago
NiLuJe c54578e254
[doc] macOS build info tweaks (#5891)
* Update macOS PATH shenanigans.

c.f., https://github.com/koreader/koreader-base/pull/1052

* Prefer coreutils, it now ships everything we need.

(Or it always did? I apparently don't actually have coreutils
installed on my end).

* Also recommend putting Homebrew first in PATH

Mainly because it turns out that's how I tested this the last time ;).
Also, it  just makes sense, and might be part of Homebrew's
recommendations anyway.
4 years ago
Thomas Spurden f3d2ef18f7
[doc] Add some basic info on using ffi-cdecl (#5808) 4 years ago
Frans de Jonge 9674928cbe
[doc] Add ragel to build prerequisites (#5743)
See discussion in https://github.com/koreader/koreader-base/pull/1025#issuecomment-570556188
4 years ago
yparitcher 0f896765c3 transifex -> weblate fixes (#5722) 4 years ago
Frans de Jonge 16fd731f73
[doc] Add coreutils to Mac brew dependencies (#5608)
See 75d02a9038 (commitcomment-36008019)
5 years ago
NiLuJe 4f52c4147f
Fix a deadlock with empty settings (#5546)
* Fix deadlock on empty settings
Emulator only. Was stuck looping forever on directory == base == .
5 years ago
NiLuJe eae105bb72
Minor dev documentatioon tweaks (#5518)
* Made Porting not so hilariously outdated.
* Minor tweaks to the macOS build instructions and the various quirks involved in getting it to behave (and accompanying actual build fixes).
5 years ago
Frans de Jonge a47b3b1a5b
[doc] Add internal documentation references (#5285)
Also some minor grammatical fixes.
5 years ago
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
5 years ago
Frans de Jonge 8be113e4bd
[fix] Update LDoc config (#5231)
Follow-up to #5217.
5 years ago
Martín Fernández 57d9f75f53 [doc] Simplify and reorganize readme (#5217)
References #5213.
5 years ago
Frans de Jonge 032d1afc8e
doc/Unit tests: minor extra explanation (#3462) 7 years ago
Frans de Jonge e566a7ffc6 kodev: add hidpi shortcut and dpi argument (#3208)
* [doc] also generate base ffi doc
* kodev: add hidpi shortcut and dpi argument
* Bump base
7 years ago
Frans de Jonge c847d628e1 Docs: cosmetic updates and additions
* Content from wiki had some cosmetic leftover glitches
* Added/adapted some docs for other modules
7 years ago
Frans de Jonge e217b99fa6 Dev docs (#2730) 7 years ago
Qingping Hou 09564d4b4d doc: event propagation for widgets 7 years ago
Dimitrios Semitsoglou-Tsiapos 2ed6cf760d Finish renaming `utils` to `tools`
Continues the work of 9afad43a3e
8 years ago
Qingping Hou 42d74c0a36 doc: add sqlite sample code 8 years ago
Qingping Hou 6493b643ec doc: Event page 8 years ago
Qingping Hou 93b9e245a9 doc: update hacking 8 years ago
Qingping Hou 815c5924e3 add documentation for wbuilder 8 years ago
Qingping Hou e410ce14df doc: types/functions for font and rendertext module 8 years ago
Qingping Hou e2096ed8d9 doc: add documentation build infrastructure 8 years ago