[Btrwiz-commits] CVS: btrwiz/src BtrWiz.java,1.2,1.3 FolderSelect.java,1.2,1.3 IncludeFilters.java,1.1,1.2 WelcomePage.java,1.2,1.3

[Mark H. <ho...@us...>]

Update of /cvsroot/btrwiz/btrwiz/src
In directory usw-pr-cvs1:/tmp/cvs-serv27037

Modified Files:
	BtrWiz.java FolderSelect.java IncludeFilters.java 
	WelcomePage.java 
Log Message:
updated javadoc documentation


Index: BtrWiz.java
===================================================================
RCS file: /cvsroot/btrwiz/btrwiz/src/BtrWiz.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** BtrWiz.java	13 Jul 2002 11:15:18 -0000	1.2
--- BtrWiz.java	13 Jul 2002 14:00:26 -0000	1.3
***************
*** 1,3 ****
- 
  import com.tildemh.jgwizard.*;
  import gnu.gdk.*;
--- 1,2 ----
***************
*** 6,18 ****
  import java.util.ResourceBundle;
  import java.util.Locale;
  class BtrWiz extends WizardForm{
  	public static final String VERSION = "2.9.0-UNSTABLE-CVS";
  	private static ResourceBundle messages;
- 	static String language = new String("en");
-     static String country = new String("GB");
-     static Locale currentLocale = new Locale(language, country);
  
  	public static void main( String[] args){
! 		messages = ResourceBundle.getBundle("InterfaceStr",currentLocale);
  		
  		Gtk.init(args.length, args);
--- 5,36 ----
  import java.util.ResourceBundle;
  import java.util.Locale;
+ 
+ /**
+  * Batch Text Replacer - a graphical application to facilitate the easy
+  * replacement of text strings withing many source files. 
+  * This is the main class which creates the application.
+  * @author Mark Howard
+  */
  class BtrWiz extends WizardForm{
+ 	/** Used in various places **/
  	public static final String VERSION = "2.9.0-UNSTABLE-CVS";
+ 	/** ResourceBundle to allow easy internationalization */
  	private static ResourceBundle messages;
  
+ 	/*
+ 	 * The following may be used to override lacale settings for development
+ 	 * purposes if needed
+ 	 */
+ 	// static String language = new String("en");
+     // static String country = new String("GB");
+     // static Locale currentLocale = new Locale(language, country);
+ 
+ 	/**
+ 	 * Starts the Gtk appication
+ 	 * @param args No arguments have been defined yet - TODO
+ 	 */
  	public static void main( String[] args){
! 		// messages = ResourceBundle.getBundle("InterfaceStr",currentLocale);
! 		 messages = ResourceBundle.getBundle("InterfaceStr", Locale.getDefault() );
  		
  		Gtk.init(args.length, args);
***************
*** 21,28 ****
--- 39,52 ----
  	}
  
+ 	/**
+ 	 * Create the application, mostly done by the superclass
+ 	 */
  	public BtrWiz(){
  		super( "BTRWiz "+VERSION );
  	}
  
+ 	/**
+ 	 * Sets up the screens of the wizard
+ 	 */
  	public void customise(){
  		WizardPage welcomePage = new WelcomePage(messages, this, messages.getString("WelcomeTitle") );

Index: FolderSelect.java
===================================================================
RCS file: /cvsroot/btrwiz/btrwiz/src/FolderSelect.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** FolderSelect.java	13 Jul 2002 11:14:30 -0000	1.2
--- FolderSelect.java	13 Jul 2002 14:00:26 -0000	1.3
***************
*** 1,3 ****
- 
  import com.tildemh.jgwizard.*;
  import gnu.gdk.*;
--- 1,2 ----
***************
*** 6,15 ****
  import java.util.ResourceBundle;
  
  class FolderSelect extends WizardPage{
  	private ResourceBundle messages;
! 		
  	private GtkVBox content;
  	GtkEntry dirEntry;
  	
  	FolderSelect(ResourceBundle rb, WizardForm parent, String title){
  		super(parent, title, null);
--- 5,23 ----
  import java.util.ResourceBundle;
  
+ 
+ /**
+  * The second page of the wizard, responsible for delecting the folders to be
+  * scanned.
+  */
  class FolderSelect extends WizardPage{
  	private ResourceBundle messages;
! 	
! 	/** The content container to be shown on the screen */
  	private GtkVBox content;
  	GtkEntry dirEntry;
  	
+ 	/**
+ 	 * Creates the graphical elements and sets up signals
+ 	 */
  	FolderSelect(ResourceBundle rb, WizardForm parent, String title){
  		super(parent, title, null);
***************
*** 36,40 ****
--- 44,55 ----
  		setContent(content);
  	}
+ 
+ 
  	GtkFileSelection selector;
+ 
+ 	/**
+ 	 * Sets up and displays a modified file selection dialog to act as a folder
+ 	 * selection dialog.
+ 	 */
  	private void showSelectBox(){
  		selector = new GtkFileSelection( messages.getString("SelDirTS") ); 
***************
*** 46,53 ****
--- 61,77 ----
  		selector.show();
  	}
+ 
+ 	/**
+ 	 * After the file selection dialog has run, this will change the selected
+ 	 * directory.
+ 	 */
  	private void setDir(){
  		dirEntry.setText(selector.getFilename());
  		rmSelector();
  	}
+ 
+ 	/**
+ 	 * Closes the folder selection dialog
+ 	 */
  	private void rmSelector(){
  		selector.destroy();

Index: IncludeFilters.java
===================================================================
RCS file: /cvsroot/btrwiz/btrwiz/src/IncludeFilters.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** IncludeFilters.java	13 Jul 2002 11:13:05 -0000	1.1
--- IncludeFilters.java	13 Jul 2002 14:00:26 -0000	1.2
***************
*** 1,3 ****
- 
  import com.tildemh.jgwizard.*;
  import gnu.gdk.*;
--- 1,2 ----
***************
*** 6,9 ****
--- 5,12 ----
  import java.util.ResourceBundle;
  
+ /**
+  * The third page of the wizard defines filters for files to be included in
+  * the scanning.
+  */
  class IncludeFilters extends WizardPage{
  	private ResourceBundle messages;
***************
*** 11,14 ****
--- 14,20 ----
  	private GtkVBox content;
  	
+ 	/**
+ 	 * Creates the page
+ 	 */
  	IncludeFilters(ResourceBundle rb, WizardForm parent, String title){
  		super(parent, title, null);

Index: WelcomePage.java
===================================================================
RCS file: /cvsroot/btrwiz/btrwiz/src/WelcomePage.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** WelcomePage.java	13 Jul 2002 11:14:30 -0000	1.2
--- WelcomePage.java	13 Jul 2002 14:00:26 -0000	1.3
***************
*** 1,3 ****
- 
  import com.tildemh.jgwizard.*;
  import gnu.gdk.*;
--- 1,2 ----
***************
*** 6,9 ****
--- 5,11 ----
  import java.util.ResourceBundle;
  
+ /**
+  * The first screen of the wizard. This gives an introduction to the program.
+  */
  class WelcomePage extends WizardPage{
  
***************
*** 11,14 ****
--- 13,19 ----
  	private ResourceBundle messages;
  	
+ 	/*
+ 	 * Creates the screen
+ 	 */
  	WelcomePage(ResourceBundle rb, WizardForm parent, String title){
  		super(parent, title, null);