Skip to content

Commit

Permalink
Merge pull request #49 from rbairwell/patch-1
Browse files Browse the repository at this point in the history
Add missing '@file' and '@stdin' tags
  • Loading branch information
kovetskiy authored Jul 28, 2022
2 parents 05b3ab5 + 56f5cc5 commit 67841df
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ file.
# @name MyLibrary
```

### `@file`

Identical to [@name](#name).

### `@brief`

A brief line about the project. Can be specified once in the beginning of the file.<br>
Expand Down Expand Up @@ -223,6 +227,19 @@ say-hello-world() {
}
```

### `@stdin`

The expected input to the function call from `stdin` (usually the terminal or command line)

**Example**
```bash
# @description Asks name.
# @stdin The users name from the terminal/command line.
say-hello-world() {
...
}
```

### `@stdout`

An expected output of the function call.
Expand Down

0 comments on commit 67841df

Please sign in to comment.