01: /*
02: * @(#)AutoDocTP.java
03: *
04: * Copyright (C) 2002-2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Part of the GroboUtils package at:
09: * http://groboutils.sourceforge.net
10: *
11: * Permission is hereby granted, free of charge, to any person obtaining a
12: * copy of this software and associated documentation files (the "Software"),
13: * to deal in the Software without restriction, including without limitation
14: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15: * and/or sell copies of the Software, and to permit persons to whom the
16: * Software is furnished to do so, subject to the following conditions:
17: *
18: * The above copyright notice and this permission notice shall be included in
19: * all copies or substantial portions of the Software.
20: *
21: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27: * DEALINGS IN THE SOFTWARE.
28: */
29: package net.sourceforge.groboutils.autodoc.v1;
30:
31: /**
32: * Test Procedure entry point. Generates Test Procedure documentation.
33: *
34: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
35: * @version $Date: 2003/02/10 22:52:11 $
36: * @since March 16, 2002
37: */
38: public interface AutoDocTP {
39: /**
40: * Defines a step which occurs during the test setup phase.
41: *
42: * @param description the text describing the step.
43: */
44: public void setupStep(String description);
45:
46: /**
47: * Defines a step which occurs during the test tear-down phase.
48: *
49: * @param description the text describing the step.
50: */
51: public void teardownStep(String description);
52:
53: /**
54: * Defines a step which occurs during the test proper.
55: *
56: * @param description the text describing the step.
57: */
58: public void step(String description);
59: }
|