Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6e6e285

Browse files
jgebaljgebal
committed
Unified annotation syntax in documentation to be --%name 
1 parent edc82cc commit 6e6e285

3 files changed

Lines changed: 21 additions & 21 deletions

File tree

‎docs/userguide/annotations.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -108,19 +108,19 @@ end test_pkg;
108108

109109
| Annotation |Level| Description |
110110
| --- | --- | --- |
111-
| `%suite(<description>)` | Package | Mandatory. Marks package as a test suite. Optional suite description can be provided (see `displayname`). |
112-
| `%suitepath(<path>)` | Package | Similar to java package. The annotation allows logical grouping of suites into hierarchies. |
113-
| `%displayname(<description>)` | Package/procedure | Human-readable and meaningful description of a suite/test. `%displayname(Name of the suite/test)`. The annotation is provided for flexibility and convenience only. It has exactly the same meaning as `<description>` in `test` and `suite` annotations. If description is provided using both `suite`/`test` and `displayname`, then the one defined as last takes precedence. |
114-
| `%test(<description>)` | Procedure | Denotes that the annotated procedure is a unit test procedure. Optional test description can by provided (see `displayname`). |
115-
| `%throws(<exception_number>[,<exception_number>[,...]])`| Procedure | Denotes that the annotated procedure must throw one of the exception numbers provided. If no valid numbers were provided as annotation parameters the annotation is ignored. Applicable to test procedures only. |
116-
| `%beforeall` | Procedure | Denotes that the annotated procedure should be executed once before all elements of the suite. |
117-
| `%afterall` | Procedure | Denotes that the annotated procedure should be executed once after all elements of the suite. |
118-
| `%beforeeach` | Procedure | Denotes that the annotated procedure should be executed before each `%test` procedure in the suite. |
119-
| `%aftereach` | Procedure | Denotes that the annotated procedure should be executed after each `%test` procedure in the suite. |
120-
| `%beforetest(<procedure_name>)` | Procedure | Denotes that mentioned procedure should be executed before the annotated `%test` procedure. |
121-
| `%aftertest(<procedure_name>)` | Procedure | Denotes that mentioned procedure should be executed after the annotated `%test` procedure. |
122-
| `%rollback(<type>)` | Package/procedure | Defines transaction control. Supported values: `auto`(default) - a savepoint is created before invocation of each "before block" is and a rollback to specific savepoint is issued after each "after" block; `manual` - rollback is never issued automatically. Property can be overridden for child element (test in suite) |
123-
| `%disabled` | Package/procedure | Used to disable a suite or a test. Disabled suites/tests do not get executed, they are however marked and reported as disabled in a test run. |
111+
| `--%suite(<description>)` | Package | Mandatory. Marks package as a test suite. Optional suite description can be provided (see `displayname`). |
112+
| `--%suitepath(<path>)` | Package | Similar to java package. The annotation allows logical grouping of suites into hierarchies. |
113+
| `--%displayname(<description>)` | Package/procedure | Human-readable and meaningful description of a suite/test. `%displayname(Name of the suite/test)`. The annotation is provided for flexibility and convenience only. It has exactly the same meaning as `<description>` in `test` and `suite` annotations. If description is provided using both `suite`/`test` and `displayname`, then the one defined as last takes precedence. |
114+
| `--%test(<description>)` | Procedure | Denotes that the annotated procedure is a unit test procedure. Optional test description can by provided (see `displayname`). |
115+
| `--%throws(<exception_number>[,<exception_number>[,...]])`| Procedure | Denotes that the annotated procedure must throw one of the exception numbers provided. If no valid numbers were provided as annotation parameters the annotation is ignored. Applicable to test procedures only. |
116+
| `--%beforeall` | Procedure | Denotes that the annotated procedure should be executed once before all elements of the suite. |
117+
| `--%afterall` | Procedure | Denotes that the annotated procedure should be executed once after all elements of the suite. |
118+
| `--%beforeeach` | Procedure | Denotes that the annotated procedure should be executed before each `%test` procedure in the suite. |
119+
| `--%aftereach` | Procedure | Denotes that the annotated procedure should be executed after each `%test` procedure in the suite. |
120+
| `--%beforetest(<procedure_name>)` | Procedure | Denotes that mentioned procedure should be executed before the annotated `%test` procedure. |
121+
| `--%aftertest(<procedure_name>)` | Procedure | Denotes that mentioned procedure should be executed after the annotated `%test` procedure. |
122+
| `--%rollback(<type>)` | Package/procedure | Defines transaction control. Supported values: `auto`(default) - a savepoint is created before invocation of each "before block" is and a rollback to specific savepoint is issued after each "after" block; `manual` - rollback is never issued automatically. Property can be overridden for child element (test in suite) |
123+
| `--%disabled` | Package/procedure | Used to disable a suite or a test. Disabled suites/tests do not get executed, they are however marked and reported as disabled in a test run. |
124124

125125
# Suitepath concept
126126

‎docs/userguide/expectations.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ begin
598598
end;
599599
/
600600
create or replace package demo_dept as
601-
-- %suite(demo)
601+
--%suite(demo)
602602

603603
--%test(demo of object to object comparison)
604604
procedure test_department;
@@ -635,7 +635,7 @@ begin
635635
end;
636636
/
637637
create or replace package demo_depts as
638-
-- %suite(demo)
638+
--%suite(demo)
639639

640640
--%test(demo of collection comparison)
641641
procedure test_departments;

‎docs/userguide/getting-started.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This way, we assure we don't jump ahead too much and produce code that is untest
2525
```sql
2626
create or replace package test_betwnstr as
2727

28-
-- %suite(Between string function)
28+
--%suite(Between string function)
2929

3030
end;
3131
/
@@ -46,9 +46,9 @@ Finished in .451423 seconds
4646
```sql
4747
create or replace package test_betwnstr as
4848

49-
-- %suite(Between string function)
49+
--%suite(Between string function)
5050

51-
-- %test(Returns substring from start position to end position)
51+
--%test(Returns substring from start position to end position)
5252
procedure basic_usage;
5353

5454
end;
@@ -201,12 +201,12 @@ A new requirement was added:
201201
```sql
202202
create or replace package test_betwnstr as
203203

204-
-- %suite(Between string function)
204+
--%suite(Between string function)
205205

206-
-- %test(Returns substring from start position to end position)
206+
--%test(Returns substring from start position to end position)
207207
procedure basic_usage;
208208

209-
-- %test(Returns substring when start position is zero)
209+
--%test(Returns substring when start position is zero)
210210
procedure zero_start_position;
211211

212212
end;

0 commit comments

Comments
 (0)