Hi,
attached patch adds doxygen style comments to the first bunch of
functions in treap.c
I've used the JAVADOC_AUTOBRIEF option of doxygen, so the first '. ' or
'.\n' is used to split brief comment from more detailed Info.
Regards,
Stefan
Index: lib/framework/treap.c
===================================================================
--- lib/framework/treap.c (revision 358)
+++ lib/framework/treap.c (working copy)
@@ -21,7 +21,10 @@
static char *pCFile;
static char pCFileNone[] = "None";
-/* Store the location in C code at which a call to the heap was made */
+/** Store the location in C code at which a call to the heap was made
+ * @param pFileName source filename
+ * @param lineNumber source file line number
+ */
void treapSetCallPos(const char *pFileName, SDWORD lineNumber)
{
cLine = lineNumber;
@@ -67,10 +87,12 @@
}
-/* Function to create a treap
- * Pass in key comparison function,
- * initial number of nodes to allocate,
- * number of additional nodes to allocate when extending.
+/** Function to create a treap.
+ * @param ppsTreap out-parameter which holds the created treap
+ * @param cmp comparison function to use
+ * @param init initial number of nodes to allocate
+ * @param ext number of additional nodes to allocate when extending.
+ * @return true, if the treap creation was successfull
*/
BOOL treapCreate(TREAP **ppsTreap, TREAP_CMP cmp, UDWORD init, UDWORD ext)
{
_______________________________________________
Warzone-dev mailing list
[email protected]
https://mail.gna.org/listinfo/warzone-dev
