added a few comments

git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2231 a95241bf-73f2-0310-859d-f6bbb57e9c96

src/add-ons/translators/tgatranslator/StreamBuffer.cpp

@@ -1,8 +1,12 @@
 /*****************************************************************************/
 // StreamBuffer
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // StreamBuffer.cpp
 //
-// The description goes here.
+// This class is for buffering data from a BPositionIO object in order to
+// improve performance for cases when small amounts of data are frequently
+// read from a BPositionIO object.
 //
 //
 // Copyright (c) 2002 OpenBeOS Project

src/add-ons/translators/tgatranslator/StreamBuffer.h

@@ -1,8 +1,12 @@
 /*****************************************************************************/
 // StreamBuffer
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // StreamBuffer.h
 //
-// The description goes here.
+// This class is for buffering data from a BPositionIO object in order to
+// improve performance for cases when small amounts of data are frequently
+// read from a BPositionIO object.
 //
 //
 // Copyright (c) 2002 OpenBeOS Project

src/add-ons/translators/tgatranslator/TGAMain.cpp

@@ -1,6 +1,6 @@
 /*****************************************************************************/
 // TGATranslator
-//
+// Written by Michael Wilber, OBOS Translation Kit Team
 // Version: 1.0.0 Beta
 //
 // This translator opens and writes TGA files.

src/add-ons/translators/tgatranslator/TGATranslator.cpp

@@ -1,5 +1,7 @@
 /*****************************************************************************/
 // TGATranslator
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGATranslator.cpp
 //
 // This BTranslator based object is for opening and writing TGA files.

src/add-ons/translators/tgatranslator/TGATranslator.h

@@ -1,5 +1,7 @@
 /*****************************************************************************/
 // TGATranslator
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGATranslator.h
 //
 // This BTranslator based object is for opening and writing TGA files.

src/add-ons/translators/tgatranslator/TGATranslatorSettings.h

@@ -1,8 +1,11 @@
 /*****************************************************************************/
 // TGATranslatorSettings
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGATranslatorSettings.h
 //
-// The description goes here.
+// This class manages (saves/loads/locks/unlocks) the settings
+// for the TGATranslator.
 //
 //
 // Copyright (c) 2002 OpenBeOS Project
@@ -43,7 +46,12 @@ public:
 	TGATranslatorSettings();
 	
 	TGATranslatorSettings *Acquire();
+		// increments the reference count, returns this
 	TGATranslatorSettings *Release();
+		// decrements the reference count, deletes this
+		// when count reaches zero, returns this when 
+		// ref count is greater than zero, NULL when
+		// ref count is zero
 	
 	status_t LoadSettings();
 	status_t LoadSettings(BMessage *pmsg);
@@ -51,8 +59,17 @@ public:
 	status_t GetConfigurationMessage(BMessage *pmsg);
 	
 	bool SetGetHeaderOnly(bool *pbHeaderOnly = NULL);
+		// sets / gets HeaderOnly setting
+		// specifies if only the image header should be
+		// outputted
 	bool SetGetDataOnly(bool *pbDataOnly = NULL);
+		// sets / gets DataOnly setting
+		// specifiees if only the image data should be
+		// outputted
 	bool SetGetRLE(bool *pbRLE = NULL);
+		// sets /gets RLE setting
+		// specifies if RLE compression will be used
+		// when the TGATranslator creates TGA images
 	
 private:
 	~TGATranslatorSettings();
@@ -62,6 +79,8 @@ private:
 	BLocker flock;
 	int32 frefCount;
 	BPath fsettingsPath;
+		// where the settings file will be loaded from /
+		// saved to
 	
 	BMessage fmsgSettings;
 		// the actual settings

src/add-ons/translators/tgatranslator/TGAView.cpp

@@ -1,5 +1,7 @@
 /*****************************************************************************/
 // TGAView
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGAView.cpp
 //
 // This BView based object displays information about the TGATranslator.
@@ -83,6 +85,19 @@ TGAView::~TGAView()
 	fpsettings->Release();
 }
 
+// ---------------------------------------------------------------
+// AllAttached
+//
+//
+//
+// Preconditions:
+//
+// Parameters:
+//
+// Postconditions:
+//
+// Returns:
+// ---------------------------------------------------------------
 void
 TGAView::AllAttached()
 {
@@ -90,6 +105,19 @@ TGAView::AllAttached()
 	fpchkRLE->SetTarget(msgr);
 }
 
+// ---------------------------------------------------------------
+// MessageReceived
+//
+// Handles state changes of the RLE setting checkbox
+//
+// Preconditions:
+//
+// Parameters: message	the actual BMessage that was received
+//
+// Postconditions:
+//
+// Returns:
+// ---------------------------------------------------------------
 void
 TGAView::MessageReceived(BMessage *message)
 {
@@ -147,4 +175,4 @@ TGAView::Draw(BRect area)
 */	
 	char writtenby[] = "Written by the OBOS Translation Kit Team";
 	DrawString(writtenby, BPoint(xbold, yplain * 7 + ybold));
-}
+}

src/add-ons/translators/tgatranslator/TGAView.h

@@ -1,5 +1,7 @@
 /*****************************************************************************/
 // TGAView
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGAView.h
 //
 // This BView based object displays information about the TGATranslator.
@@ -53,6 +55,8 @@ private:
 	BCheckBox *fpchkRLE;
 	
 	TGATranslatorSettings *fpsettings;
+		// the actual settings for the translator,
+		// shared with the translator
 };
 
 #endif // #ifndef TGAVIEW_H

src/add-ons/translators/tgatranslator/TGAWindow.cpp

@@ -1,5 +1,7 @@
 /*****************************************************************************/
 // TGAWindow
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGAWindow.cpp
 //
 // This BWindow based object is used to hold the TGAView object when the

src/add-ons/translators/tgatranslator/TGAWindow.h

@@ -1,5 +1,7 @@
 /*****************************************************************************/
 // TGAWindow
+// Written by Michael Wilber, OBOS Translation Kit Team
+//
 // TGAWindow.h
 //
 // This BWindow based object is used to hold the TGAView object when the