doc: Event page

koreader · Mar 12, 2016 · 6493b64 · 6493b64
1 parent c8cd1d6
commit 6493b64
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/doc/Events.md b/doc/Events.md
@@ -0,0 +1,10 @@
+Builtin Events
+==============
+
+Reader Events
+-------------
+
+* UpdatePos: emitted by typesetting related modules to notify other modules to
+recalculate the view based on the new typesetting.
+
+* PosUpdate: emitted by readerrolling module to signal a change in pos.
diff --git a/doc/config.ld b/doc/config.ld
@@ -5,7 +5,7 @@ title = 'KOReader Documentation'
 dir = 'html'
 style = '!fixed'
 use_markdown_titles = true
-topics = {'../README.md', './Hacking.md'}
+topics = {'../README.md', './Hacking.md', './Events.md'}
 package = ''
 format = 'markdown'
 sort_modules = true