bug 801466 - fix comment about nsReadLine usage
authorTrevor Saunders <trev.saunders@gmail.com>
Wed, 05 Dec 2012 23:51:15 -0500
changeset 115157 e2c0679596eb8b42a1eaf35231048895fc1d057e
parent 115156 f268ed46d577ae09a1468b7df094d90eee548bc7
child 115158 ddda5400c826130cce3dbc5432ddb5cffa8a2d76
child 115180 8c95cee5cd9e688ae55fc60a5d9d5370b7c34977
push id23973
push useremorley@mozilla.com
push dateThu, 06 Dec 2012 10:04:18 +0000
treeherdermozilla-central@ddda5400c826 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
bugs801466
milestone20.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
bug 801466 - fix comment about nsReadLine usage
netwerk/base/public/nsReadLine.h
--- a/netwerk/base/public/nsReadLine.h
+++ b/netwerk/base/public/nsReadLine.h
@@ -9,22 +9,21 @@
 
 #include "nsIInputStream.h"
 #include "mozilla/Likely.h"
 
 /**
  * @file
  * Functions to read complete lines from an input stream.
  *
- * To properly use the helper function in here (NS_ReadLine) the caller
- * needs to declare a pointer to an nsLineBuffer, call
- * NS_InitLineBuffer on it, and pass it to NS_ReadLine every time it
+ * To properly use the helper function in here (NS_ReadLine) the caller should
+ * create a nsLineBuffer<T> with new, and pass it to NS_ReadLine every time it
  * wants a line out.
  *
- * When done, the pointer should be freed using PR_Free.
+ * When done, the object should be deleted.
  */
 
 /**
  * @internal
  * Buffer size. This many bytes will be buffered. If a line is longer than this,
  * the partial line will be appended to the out parameter of NS_ReadLine and the
  * buffer will be emptied.
  * Note: if you change this constant, please update the regression test in