From 567a325be51466498fc9a23ea6669a5d5127a93f Mon Sep 17 00:00:00 2001
From: helge <helge@e4a50df8-12e2-0310-a44c-efbce7f8a7e3>
Date: Sun, 28 Nov 2004 18:00:00 +0000
Subject: [PATCH] Id fixes and comments

git-svn-id: http://svn.opengroupware.org/SOPE/trunk@419 e4a50df8-12e2-0310-a44c-efbce7f8a7e3
---
 sope-core/NGStreams/NGStreams/NGBufferedStream.h   |  5 ++---
 sope-core/NGStreams/NGStreams/NGCTextStream.h      |  8 ++++----
 sope-core/NGStreams/NGStreams/NGFilterStream.h     | 11 +++++++++--
 sope-core/NGStreams/NGStreams/NGStringTextStream.h | 11 ++++++++---
 sope-core/NGStreams/NGStreams/NGTextStream.h       |  7 +++++++
 5 files changed, 30 insertions(+), 12 deletions(-)

diff --git a/sope-core/NGStreams/NGStreams/NGBufferedStream.h b/sope-core/NGStreams/NGStreams/NGBufferedStream.h
index 0e7a5112..cc884025 100644
--- a/sope-core/NGStreams/NGStreams/NGBufferedStream.h
+++ b/sope-core/NGStreams/NGStreams/NGBufferedStream.h
@@ -1,7 +1,7 @@
 /*
   Copyright (C) 2000-2004 SKYRIX Software AG
 
-  This file is part of OGo
+  This file is part of OpenGroupware.org.
 
   OGo is free software; you can redistribute it and/or modify it under
   the terms of the GNU Lesser General Public License as published by the
@@ -18,7 +18,6 @@
   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 */
-// $Id$
 
 #ifndef __NGStreams_NGBufferedStream_H__
 #define __NGStreams_NGBufferedStream_H__
@@ -43,7 +42,7 @@
 }
 
 + (id)filterWithSource:(id<NGStream>)_source bufferSize:(unsigned)_size;
-- (id)initWithSource:(id<NGStream>)_source bufferSize:(unsigned)_size;
+- (id)initWithSource:(id<NGStream>)_source   bufferSize:(unsigned)_size;
 - (id)initWithSource:(id<NGStream>)_source;
 
 /* accessors */
diff --git a/sope-core/NGStreams/NGStreams/NGCTextStream.h b/sope-core/NGStreams/NGStreams/NGCTextStream.h
index f611ddce..b4ce71d0 100644
--- a/sope-core/NGStreams/NGStreams/NGCTextStream.h
+++ b/sope-core/NGStreams/NGStreams/NGCTextStream.h
@@ -1,7 +1,7 @@
 /*
-  Copyright (C) 2000-2003 SKYRIX Software AG
+  Copyright (C) 2000-2004 SKYRIX Software AG
 
-  This file is part of OGo
+  This file is part of OpenGroupware.org.
 
   OGo is free software; you can redistribute it and/or modify it under
   the terms of the GNU Lesser General Public License as published by the
@@ -18,7 +18,6 @@
   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 */
-// $Id$
 
 #ifndef __NGStreams_NGCTextStream_H__
 #define __NGStreams_NGCTextStream_H__
@@ -46,7 +45,8 @@ NGStreams_EXPORT void NGInitTextStdio(void);
   7bit ASCII set.
   NGCTextStream never returns a character value above 255.
   
-  To retrieve correctly converted unicode characters use the NGTextStream class.
+  To retrieve correctly converted unicode characters use the NGTextStream
+  class.
 */
 
 @interface NGCTextStream : NGTextStream
diff --git a/sope-core/NGStreams/NGStreams/NGFilterStream.h b/sope-core/NGStreams/NGStreams/NGFilterStream.h
index ef92ced1..1a91f7d6 100644
--- a/sope-core/NGStreams/NGStreams/NGFilterStream.h
+++ b/sope-core/NGStreams/NGStreams/NGFilterStream.h
@@ -1,7 +1,7 @@
 /*
   Copyright (C) 2000-2004 SKYRIX Software AG
 
-  This file is part of OGo
+  This file is part of OpenGroupware.org.
 
   OGo is free software; you can redistribute it and/or modify it under
   the terms of the GNU Lesser General Public License as published by the
@@ -18,13 +18,20 @@
   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 */
-// $Id$
 
 #ifndef __NGStreams_NGFilterStream_H__
 #define __NGStreams_NGFilterStream_H__
 
 #include <NGStreams/NGStream.h>
 
+/*
+  NGFilterStream
+  
+  This is an abstract superclass for streams which just operate on 'basic'
+  streams like sockets or file streams. As an example subclass take the
+  buffered stream which performs buffered IO on any given stream.
+*/
+
 @interface NGFilterStream : NGStream
 {
 @protected
diff --git a/sope-core/NGStreams/NGStreams/NGStringTextStream.h b/sope-core/NGStreams/NGStreams/NGStringTextStream.h
index 556890f9..183ab1e0 100644
--- a/sope-core/NGStreams/NGStreams/NGStringTextStream.h
+++ b/sope-core/NGStreams/NGStreams/NGStringTextStream.h
@@ -1,7 +1,7 @@
 /*
-  Copyright (C) 2000-2003 SKYRIX Software AG
+  Copyright (C) 2000-2004 SKYRIX Software AG
 
-  This file is part of OGo
+  This file is part of OpenGroupware.org.
 
   OGo is free software; you can redistribute it and/or modify it under
   the terms of the GNU Lesser General Public License as published by the
@@ -18,7 +18,6 @@
   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 */
-// $Id$
 
 #ifndef __NGStreams_NGStringTextStream_H__
 #define __NGStreams_NGStringTextStream_H__
@@ -26,6 +25,12 @@
 #include <NGStreams/NGTextStream.h>
 #include <NGStreams/NGTextStreamProtocols.h>
 
+/*
+  NGStringTextStream
+  
+  A text stream which navigates inside an NSString or NSMutableString object.
+*/
+
 @interface NGStringTextStream : NGTextStream
 {
 @private
diff --git a/sope-core/NGStreams/NGStreams/NGTextStream.h b/sope-core/NGStreams/NGStreams/NGTextStream.h
index 2eb9ba86..8e062d96 100644
--- a/sope-core/NGStreams/NGStreams/NGTextStream.h
+++ b/sope-core/NGStreams/NGStreams/NGTextStream.h
@@ -25,6 +25,13 @@
 #import <Foundation/NSObject.h>
 #include <NGStreams/NGTextStreamProtocols.h>
 
+/*
+  NGTextStream
+  
+  Abstract superclass for 'text streams'. Text streams are streams which
+  are based on unichars and NSStrings instead of bytes and byte buffers.
+*/
+
 @class NSException;
 
 @interface NGTextStream : NSObject < NGExtendedTextStream >
-- 
2.39.5