Skip to content

Commit fb53766

Browse files
ajout documentation
1 parent 32775f1 commit fb53766

File tree

5 files changed

+35
-0
lines changed

5 files changed

+35
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Compatible with every [currently supported Symfony versions](https://symfony.com
3434
- [ConstantOutputTask](doc/reference/tasks/constant_output_task.md)
3535
- [ConstantIterableOutputTask](doc/reference/tasks/constant_iterable_output_task.md)
3636
- [DebugTask](doc/reference/tasks/debug_task.md)
37+
- [DieTask](doc/reference/tasks/die_task.md)
3738
- [DummyTask](doc/reference/tasks/dummy_task.md)
3839
- [EventDispatcherTask](doc/reference/tasks/event_dispatcher_task.md)
3940
- Data manipulation and transformations

doc/reference/tasks/debug_task.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,8 @@ Possible outputs
1919
----------------
2020

2121
`any`: re-output given input
22+
23+
Example
24+
----------------
25+
26+
https://github.com/cleverage/process-bundle-ui-demo/blob/main/config/packages/process/demo.debug.yaml

doc/reference/tasks/die_task.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
DieTask
2+
=========
3+
4+
Stops the process brutally
5+
6+
7+
Task reference
8+
--------------
9+
10+
* **Service**: `CleverAge\ProcessBundle\Task\Debug\DieTask`
11+
12+
Accepted inputs
13+
---------------
14+
15+
`any`
16+
17+
Possible outputs
18+
----------------
19+
20+
None
21+
22+
Example
23+
----------------
24+
25+
https://github.com/cleverage/process-bundle-ui-demo/blob/main/config/packages/process/demo.die.yaml

src/Task/Debug/DebugTask.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
/**
2121
* Dump the content of the input
22+
*
23+
* @example https://github.com/cleverage/process-bundle-ui-demo/blob/main/config/packages/process/demo.debug.yaml
2224
*/
2325
class DebugTask implements TaskInterface
2426
{

src/Task/Debug/DieTask.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
* Class DieTask
2121
*
2222
* Stops the process brutally
23+
*
24+
* @example https://github.com/cleverage/process-bundle-ui-demo/blob/main/config/packages/process/demo.die.yaml
2325
*/
2426
class DieTask implements TaskInterface
2527
{

0 commit comments

Comments
 (0)