From: bruce m. <tr...@us...> - 2004-07-30 01:33:42
|
Update of /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/command In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7955/modules/core/src/com/babeldoc/core/pipeline/command Modified Files: PipelineCommand.java PipelineCommandTest.java PipelineFeeder.java Log Message: javadoc and formatting here. Index: PipelineFeeder.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/command/PipelineFeeder.java,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** PipelineFeeder.java 23 Jul 2004 22:38:08 -0000 1.11 --- PipelineFeeder.java 30 Jul 2004 01:33:02 -0000 1.12 *************** *** 85,89 **** /** ! * Introduce a document with attributes into the pipeline. See the usage * instructions for more help. This is a very useful command that is the main * front end for pipeline processing in babeldoc. It has a number of static --- 85,89 ---- /** ! * Feed a document (with attributes) into the pipeline. See the usage * instructions for more help. This is a very useful command that is the main * front end for pipeline processing in babeldoc. It has a number of static *************** *** 95,99 **** */ public class PipelineFeeder extends BabeldocCommand { ! /** constant attribute name for the filename */ public static final String FILE_NAME = "file_name"; --- 95,99 ---- */ public class PipelineFeeder extends BabeldocCommand { ! /** constant attribute name for the filename. */ public static final String FILE_NAME = "file_name"; *************** *** 101,107 **** /** ! * process the class * ! * @param args DOCUMENT ME! */ public PipelineFeeder(String[] args) { --- 101,107 ---- /** ! * process the class. * ! * @param args command line arguments */ public PipelineFeeder(String[] args) { *************** *** 111,115 **** /** * Extract a set of properties from the command line arguments skipping the ! * first argument which is the pipeline stage name * * @param args the array of command line arguments --- 111,115 ---- /** * Extract a set of properties from the command line arguments skipping the ! * first argument which is the pipeline stage name. * * @param args the array of command line arguments *************** *** 137,141 **** /** ! * Execute the command * * @param commandLine The command line. --- 137,141 ---- /** ! * Execute the command. * * @param commandLine The command line. *************** *** 172,176 **** /** ! * Main entry point * * @param args the name of the stage and the name=value pairs --- 172,176 ---- /** ! * Main entry point. * * @param args the name of the stage and the name=value pairs Index: PipelineCommandTest.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/command/PipelineCommandTest.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** PipelineCommandTest.java 16 Sep 2003 05:19:01 -0000 1.4 --- PipelineCommandTest.java 30 Jul 2004 01:33:02 -0000 1.5 *************** *** 82,86 **** * Creates a new PipelineCommandTest object. * ! * @param testName DOCUMENT ME! */ public PipelineCommandTest(String testName) { --- 82,86 ---- * Creates a new PipelineCommandTest object. * ! * @param testName junit test name */ public PipelineCommandTest(String testName) { *************** *** 91,95 **** * Run all the test methods in this class. * ! * @param args DOCUMENT ME! */ public static void main(String[] args) { --- 91,95 ---- * Run all the test methods in this class. * ! * @param args command line arguments */ public static void main(String[] args) { *************** *** 98,102 **** /** ! * Make a test suite * * @return get the test suite --- 98,102 ---- /** ! * Make a test suite. * * @return get the test suite *************** *** 109,113 **** /** ! * setup the test pipeline and stage */ public void testPipelineAndStage() { --- 109,113 ---- /** ! * setup the test pipeline and stage. */ public void testPipelineAndStage() { *************** *** 119,123 **** /** ! * Setup the test * * @throws Exception --- 119,123 ---- /** ! * Setup the test. * * @throws Exception *************** *** 128,132 **** /** ! * Teardown the test * * @throws Exception --- 128,132 ---- /** ! * Teardown the test. * * @throws Exception Index: PipelineCommand.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/command/PipelineCommand.java,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** PipelineCommand.java 16 Sep 2003 05:19:01 -0000 1.11 --- PipelineCommand.java 30 Jul 2004 01:33:02 -0000 1.12 *************** *** 90,94 **** public class PipelineCommand extends BabeldocCommand { /** ! * Process the commands on the command line * * @param args the command line --- 90,94 ---- public class PipelineCommand extends BabeldocCommand { /** ! * Process the commands on the command line. * * @param args the command line *************** *** 99,105 **** /** ! * Process - list all the pipelines in the system * ! * @throws Exception DOCUMENT ME! */ public void doPipelineList() throws Exception { --- 99,105 ---- /** ! * Process - list all the pipelines in the system. * ! * @throws Exception */ public void doPipelineList() throws Exception { *************** *** 115,119 **** /** ! * Execute the command line * * @param commandLine to be executed --- 115,119 ---- /** ! * Execute the command line. * * @param commandLine to be executed *************** *** 143,149 **** /** ! * Main routine * ! * @param args */ public static void main(String[] args) { --- 143,149 ---- /** ! * Main routine. * ! * @param args command line arguments. */ public static void main(String[] args) { *************** *** 153,157 **** /** ! * Setup the command line arguments * * @param options the commandline options to look for --- 153,157 ---- /** ! * Setup the command line arguments. * * @param options the commandline options to look for *************** *** 195,203 **** /** ! * do configuration listing. ! * ! * @param pipelineStage * ! * @throws Exception DOCUMENT ME! */ protected void doConfig(String pipelineStage) throws Exception { --- 195,202 ---- /** ! * List all the configuratiooptions for the named pipeline stage. * ! * @param pipelineStage pipeline stage name to list ! * @throws Exception */ protected void doConfig(String pipelineStage) throws Exception { *************** *** 222,230 **** /** ! * do connectivity listing. ! * ! * @param pipelineRange * ! * @throws Exception DOCUMENT ME! */ protected void doConnectivity(String pipelineRange) throws Exception { --- 221,228 ---- /** ! * do connectivity listing of a range of pipeline stages. * ! * @param pipelineRange range of stages ! * @throws Exception */ protected void doConnectivity(String pipelineRange) throws Exception { *************** *** 264,272 **** /** ! * do type listing. ! * ! * @param pipelineStage * ! * @throws Exception DOCUMENT ME! */ protected void doType(String pipelineStage) throws Exception { --- 262,269 ---- /** ! * Get the type information for the pipeline stage name. * ! * @param pipelineStage name of the pipeline stage ! * @throws Exception */ protected void doType(String pipelineStage) throws Exception { *************** *** 285,293 **** /** ! * do xml listing. ! * ! * @param pipelineStage * ! * @throws Exception DOCUMENT ME! */ protected void doXml(String pipelineStage) throws Exception { --- 282,289 ---- /** ! * List the pipeline stage in XML format. * ! * @param pipelineStage pipeline stage name ! * @throws Exception */ protected void doXml(String pipelineStage) throws Exception { *************** *** 313,317 **** /** ! * Output the configuration information * * @param indent - indent spacing. --- 309,313 ---- /** ! * Output the configuration information. * * @param indent - indent spacing. *************** *** 349,359 **** /** ! * Get the pipeline stage factory for the pair * * @param pair the pipeline name/stage name pair - * * @return the pipeline stage factory. ! * ! * @throws PipelineException DOCUMENT ME! */ IPipelineStageFactory getPipelineStageFactory(com.babeldoc.core.Pair pair) --- 345,353 ---- /** ! * Get the pipeline stage factory for the pair. * * @param pair the pipeline name/stage name pair * @return the pipeline stage factory. ! * @throws PipelineException */ IPipelineStageFactory getPipelineStageFactory(com.babeldoc.core.Pair pair) *************** *** 374,380 **** * Process the list command - See the print usage for usage instructions. * ! * @param commandLine ! * ! * @throws Exception DOCUMENT ME! */ void doList(CommandLine commandLine) throws Exception { --- 368,373 ---- * Process the list command - See the print usage for usage instructions. * ! * @param commandLine processed command line ! * @throws Exception */ void doList(CommandLine commandLine) throws Exception { |