Status Report

["Daniel E. Markle" <syntax@ashtech.pa.net>]

My major projects at the moment include the function documentation and the
edit forms needed for moderation.  Both of these are way behind schedule, but
I won't spend time whining as to why, I'll just get the damned things done ;)

Here's an example of how the function documentation will work.  The point of
this system isn't to actually automatically document the code, which is nearly
impossible to do correctly, but to provide an easy in-code method to write the
docs that can be used to generate easily readable documentation, while trying
to minimally interfere with different coding styles and languages.

---- start example code snippet ----
#D function
#D value 	$message - string containing error message describing why we
#D- are stoping rendering.
#D returns 	nothing
#D description 	Halts object rendering, returns error message.
function halt_render ($message) {
---- end example code snippet ----

---- start example output snippet ----
Function:
halt_render

Description:
Halts object rendering, returns error message.

Prototype:
function halt_render ($message);

Variable(s):
$message - string containing error message describing why we
	are stoping rendering.

Returns:
nothing
---- end example output snippet ----

Those of you who have been following this will notice I changed the #*** thing
to #D.  #*** is too much to type, #D should never occur at the front of a line
unless someone doesn't put a space after the #, and those will be caught by
the lack of a space after or an identifer after.

At any rate, unique enough identifiers are being used that we can change them
to anything we want later, for use in other languages, etc.

The function documentation scripts at least should be done tommorrow, vicman
will be thrilled to know I am doing them in Perl ;)  Actually 
documenting the functions should be done by the end of this week, into the 
beginning of the next.

Edit forms are also a priority, and them not being done is causing problems
for chardros trying to get the moderation system working.  I will do my best
to get them done by the end of this weekend, if I can't get them working
sooner.

-- 
-------------------
Daniel E. Markle
syntax@ashtech.net
http://www.ashtech.net/syntax
-------------------