We wish to document large codes in such a way that there are clear human readable comments in the source code and these comments can be parsed to create high quality html documentation. Thus, we propose a set of parseable documenting conventions for all source codes written hereafter.The grdoc system consists of the software to turn these parseable comments into html documentation. The documentation contains cross referenced code and variable descriptions, a well as calling trees.
The system is named grdoc since it was orignally designed to document large codes in the NCSA Relativity Group (General Relativity = gr). However, many disciplines create large codes and need accesible browseable documentation for those codes, and the system has no special limitation which requires it to be used for gr codes.
This system was inspired by Sun Microsystem's javadoc system, although since the languages we deal with are less structured, consequently, our documenting system can place less emphasis on the object oriented nature of java and the java api, and must allow more free form documenting.