Skip to content

Commit

Permalink
added doc for params --version and --verbose
Browse files Browse the repository at this point in the history
  • Loading branch information
Dudo1985 committed May 10, 2024
1 parent dc19a38 commit fa7b507
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ Only parse hooks or shortcodes starting with the specified prefixes.

#### `vendor/bin/wp-doc-gen . hooks.md --exclude vendor node_modules --prefix prefix_1 prefix_2`

---

#### `--verbose` or `-v`
More detailed error messages.

---

#### `--version` or `-V`
Print the version number

## Real life Examples
### Generated markdown files
- https://github.com/Dudo1985/Yet-Another-Stars-Rating/blob/master/docs/yasr_hooks.md
Expand Down
6 changes: 3 additions & 3 deletions examples/hooks.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

### `do_action('yasr_add_settings_tab')`

Source: [examples//hooks.php, line 12](examples//hooks.php:12)
Source: [examples/hooks.php, line 12](examples/hooks.php:12)

_Hook here to add new settings tab_

Expand All @@ -13,7 +13,7 @@ _This is the second line_
___
### `do_action('yasr_right_settings_panel_box')`

Source: [examples//hooks.php, line 19](examples//hooks.php:19)
Source: [examples/hooks.php, line 19](examples/hooks.php:19)

_Hook here to add new settings tab_

Expand All @@ -23,7 +23,7 @@ _Hook here to add new settings tab_
___
### `apply_filters('yasr_vv_cookie')`

Source: [examples//hooks.php, line 24](examples//hooks.php:24)
Source: [examples/hooks.php, line 24](examples/hooks.php:24)

_customize visitor_votes cookie name, no param given just the description_

Expand Down
2 changes: 1 addition & 1 deletion src/WPDocGen.php
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ function printVersion($argv): void {
* @return bool
* @author Dario Curvino <@dudo>
*
* @since
* @since 2.0.0
*/
function verboseOutput($argv): bool {
if (in_array('--verbose', $argv) || in_array('-v', $argv)) {
Expand Down

0 comments on commit fa7b507

Please sign in to comment.