ddstring: Elaborated on Str_InitStatic() apidoc

skyjake · Jan 6, 2012 · 3cc2ad6 · 3cc2ad6
1 parent 6363620
commit 3cc2ad6
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/doomsday/engine/api/dd_string.h b/doomsday/engine/api/dd_string.h
@@ -101,6 +101,7 @@ void Str_InitStd(ddstring_t* ds);
 /**
  * Initializes @a ds with a static const C string. No memory allocation
  * model is selected; use this for strings that remain constant.
+ * If the string is never modified calling Str_Free() is not needed.
  */
 void Str_InitStatic(ddstring_t* ds, const char* staticConstStr);