Changeset 91dd8a5 in git for libpolys/reporter/reporter.h

Timestamp:

Mar 10, 2014, 5:25:17 PM (10 years ago)

Author:

Hans Schoenemann <hannes@…>

Branches:

(u'spielwiese', '873fc1222e995d7cb33f79d8f1792ce418c8c72c')

Children:

fa502097e0f6e99adaf0a797bd0957c1c79369ba

Parents:

daa13f7cda0d499a1e8ef40d88b9b73bf2494fc2

Message:

add: description for StringSetS/..StringEndS, SPrintStart/SPrintEnd

File:

• libpolys/reporter/reporter.h (modified) (2 diffs)

libpolys/reporter/reporter.h

@@ -60 +60 @@
 /* the C++-part: */
 
+// a new output buffer will be allocated by StringSetS,
+// used by several calls to StringAppend/StringAppendS
+// and closed by StringEndS:
+// StringEndS() returns this buffer which must be freed by omFree
+// several buffer may be active at the same time
+// (for example in subroutines)
 void  StringAppend(const char *fmt, ...);
 void  StringAppendS(const char *s);
@@ -77 +83 @@
  * (i.e. if Singular runs as a server)
  */
+// unlike the StringSet/StringEndS stuff: 
+// only one SPrintStart/SPrintEnd buffer may be active
+// the returned string must be free via omFree
 void SPrintStart();
 char* SPrintEnd();