Changeset 37208 in vbox for trunk/include

Timestamp:

May 25, 2011 9:22:18 AM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

71904

Message:

circbuf: code cleanup.

File:

• trunk/include/iprt/circbuf.h (modified) (3 diffs)

trunk/include/iprt/circbuf.h

@@ -42 +42 @@
 RT_C_DECLS_BEGIN
 
+/** @todo r=bird: this is missing docs and magic. uXPos should be offX.
+ *        cbBufSize should be cbBuf. */
 typedef struct RTCIRCBUF
 {
@@ -71 +73 @@
  * Destroy the circular buffer.
  *
- * @param   pBuf           The buffer to destroy.
+ * @param   pBuf           The buffer to destroy.  NULL is ignored.
  */
 RTDECL(void) RTCircBufDestroy(PRTCIRCBUF pBuf);
-
 
 /**
@@ -146 +147 @@
 /** @} */
 
-#endif /* ___iprt_circbuf_h */
+#endif /* !___iprt_circbuf_h */