Id fixes and comments

git-svn-id: http://svn.opengroupware.org/SOPE/trunk@419 e4a50df8-12e2-0310-a44c-efbce7f8a7e3

diff --git a/sope-core/NGStreams/NGStreams/NGBufferedStream.h b/sope-core/NGStreams/NGStreams/NGBufferedStream.h
index 0e7a5112d29727fede3c90c1c7e42510155b3d77..cc8840259fc1878ae74afcfd32a934cb6050d090 100644 (file)
--- 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 f611ddced51c2d8b2fd5d1390ca4825a6410607c..b4ce71d0be6e271ecf73910b579cb64babb0f36b 100644 (file)
--- 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 ef92ced1219cf827147586f7c4ccfa3bef6ca10a..1a91f7d6a5706b0626837b7d63f1c93786741ac8 100644 (file)
--- 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 556890f9579097441bdbe65f4054e6498ed3fa6f..183ab1e086ce7afac6519fd1327304267ae6ea3f 100644 (file)
--- 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 2eb9ba861df551bc0e69331c78cb338e09ea9b1f..8e062d969e420b95f818c8ce033a9ddf8e0cc799 100644 (file)
--- 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 >