From ff52a2ab595a10b52f965693e23e9616509695ae Mon Sep 17 00:00:00 2001
From: Paul Beckingham <paul@beckingham.net>
Date: Tue, 13 May 2014 18:58:57 -0400
Subject: [PATCH] Hooks

- Defined the interface for ::onLaunch and ::onExit.
---
 src/Hooks.cpp | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/Hooks.cpp b/src/Hooks.cpp
index 6f1d0d2b6..abde14f47 100644
--- a/src/Hooks.cpp
+++ b/src/Hooks.cpp
@@ -56,6 +56,13 @@ void Hooks::initialize ()
 }
 
 ////////////////////////////////////////////////////////////////////////////////
+// Occurs when:       On launch, after data structures are initiliazed, before
+//                    data is loaded.
+// Data fed to stdin: None
+// Exit code:         0: Success, proceed
+//                    !0: Failure, terminate
+// Output handled:    0:  context.footnote ()
+//                    !0: context.error ()
 void Hooks::onLaunch ()
 {
   context.timer_hooks.start ();
@@ -67,6 +74,13 @@ void Hooks::onLaunch ()
 }
 
 ////////////////////////////////////////////////////////////////////////////////
+// Occurs when:       On exit, after processing is complete, before output is
+//                    displayed.
+// Data fed to stdin: None
+// Exit code:         0: Success
+//                    !0: Failure
+// Output handled:    0:  context.footnote ()
+//                    !0: context.error ()
 void Hooks::onExit ()
 {
   context.timer_hooks.start ();