From 3e34e06c68ba755d17d81dc16e78cee50ccc48f8 Mon Sep 17 00:00:00 2001 From: Dmitry Khomutov Date: Sat, 20 Jan 2018 16:52:45 +0700 Subject: [PATCH] Improved Pdepend plugin documentation. Issue #143. --- docs/en/plugins/pdepend.md | 9 ++++++++- docs/en/plugins/phar.md | 2 +- docs/en/plugins/php_cpd.md | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/en/plugins/pdepend.md b/docs/en/plugins/pdepend.md index 68610f64..90abd8c8 100644 --- a/docs/en/plugins/pdepend.md +++ b/docs/en/plugins/pdepend.md @@ -8,4 +8,11 @@ Configuration ### Options -* **directory** - Required - Directory in which to run PDepend. +* **directory** [string, optional] - Directory in which to run PDepend (default: `%BUILD_PATH%`). + +### Examples + +```yaml +pdepend: + directory: ./src +``` diff --git a/docs/en/plugins/phar.md b/docs/en/plugins/phar.md index 5294b1ce..70d2af9c 100644 --- a/docs/en/plugins/phar.md +++ b/docs/en/plugins/phar.md @@ -15,7 +15,7 @@ Configuration ### Examples -``` +```yaml phar: directory: /path/to/directory filename: foobar.phar diff --git a/docs/en/plugins/php_cpd.md b/docs/en/plugins/php_cpd.md index 8371b1ac..032e01ad 100644 --- a/docs/en/plugins/php_cpd.md +++ b/docs/en/plugins/php_cpd.md @@ -8,7 +8,7 @@ Configuration ### Options -* **path** - Optional - Path in which to run PHP Copy/Paste Detector (default: build root). +* **path** - Optional - Path in which to run PHP Copy/Paste Detector (default: `%BUILD_PATH%`). * **ignore** - Optional - A list of files / paths to ignore (default: build_settings > ignore). ### Examples