# HG changeset patch
# User Binki <ohnobinki@ohnopublishing.net>
# Date 2009-07-24 20:38:54
# Node ID 313023865fdb9e5df6fc998f1a3e350e107558fb
# Parent  fd42293109702a6082a71471a0f95b803b4b0d98

status_report_generator: added doxygen, clarified comments

diff --git a/src/server/distrend.c b/src/server/distrend.c
--- a/src/server/distrend.c
+++ b/src/server/distrend.c
@@ -180,10 +180,12 @@ jobnum++; // Advance the jobnumber for t
 }
 
 
-/*
-  Status Report Generator: figures out how much of the job is done, where jobnum corresponds to the job number
+/**
+  Status Report Generator: 
+  -figures out how much of the job is done, where jobnum corresponds to the job number
+  -removes finished jobs
 
-  blendjobs_head is a pointer to a pointer because the head of the blendjobs linked list may need to be changed by blendjob_remove
+  @param blendjobs_head a pointer to a pointer because the head of the blendjobs linked list may need to be changed by blendjob_remove
 */
 void status_report_generator(struct blendjob **blendjobs_head)
 {