Added usage notes.

git-svn-id: https://vassalengine.svn.sourceforge.net/svnroot/vassalengine/site-src/trunk@6796 67b53d14-2c14-4ace-a08f-0dab2b34000c

1 files changed, 6 insertions, 1 deletions

diff --git a/src/forum_post_delete.php b/src/forum_post_delete.php
index f1fabde..177d08e 100644
--- a/src/forum_post_delete.php
+++ b/src/forum_post_delete.php
@@ -1,5 +1,11 @@
 <?php
 
+#
+# Usage: In posting.php, following delete_post():
+# 
+# require_once('/home/uckelman/site-src/bridge/src/forum_post_delete.php'); 
+#
+
 try {
   remove_post($post_id);
 }
@@ -7,7 +13,6 @@ catch (Exception $e) {
   trigger_error($e, E_USER_ERROR);
 }
 
-# TODO: call this from handle_post_delete in posting.php
 function remove_post($postId) {
   require_once(__DIR__ . '/Bridge.php');