Next Previous Contents

6. Submissions to the DOC++ Source Reference

The Q2DP_DLLdoc collection is created from the C sources of the Game DLL as of version 3.14, with changes to the sources, additional headers, and javadoc-style annotation.

The best way to contribute here is to get the annotated Game DLL sources (the gameq file) from the Q2DParchive. Track down the phrase that is wrong, or the function you want to annotate. Comments are bracketed with /** ... comments here ... */, so simply cut out that part, change it, and send it as plain ASCII. Or create a paragraph bracketed like that. You can add simple (non-structural) HTML tags like <ul>, <li>, <em>, <b>, <tt>, and <pre> plus the HREF and NAME anchors, but no sections, rules, or images.

Please make sure to list the name of the function, struct, define or macro you want to add annotation to, and the file it is in, like g_phys.c::SV_AddGravity.


Next Previous Contents