47 Commits

Author SHA1 Message Date
antonmedv
b8da0f0b27 [automatic] Update docs with bin/docgen 2023-10-27 12:32:05 +00:00
antonmedv
bf65435cba [automatic] Update docs with bin/docgen 2022-10-17 07:11:22 +00:00
Marcus Jaschen
717a1a047f
fix closing backtick for inline Markdown code (#3261) 2022-08-17 21:06:05 +02:00
Anton Medvedev
a617327c5c Update ApiGen.php 2022-04-15 23:17:54 +02:00
Mathieu I
9fbb270d99
Fix phpcs update (#3032)
* Bump slevomat/coding-standard from 6.4.1 to 7.0.19

Bumps [slevomat/coding-standard](https://github.com/slevomat/coding-standard) from 6.4.1 to 7.0.19.
- [Release notes](https://github.com/slevomat/coding-standard/releases)
- [Commits](https://github.com/slevomat/coding-standard/compare/6.4.1...7.0.19)

---
updated-dependencies:
- dependency-name: slevomat/coding-standard
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* style: fix all errors reported by phpcs

* style: remove typehints incompatible with php 7

* chore: update phpcs config

* chore: add missing docblocks

* style: remove useless ignore statements

* fix: remove extra mixed typehints

* fix: update api.md

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mathieu Imbert <mathieu.imbert@tracktik.com>
2022-03-13 00:28:16 +01:00
Markus Staab
4d2ddce8ad
Cleanup code (#2974)
* Task: added phpdocs

* Update Task.php

* add callable phpdocs

* remove useless bool-return

* remove useless return

* remove useless return

* run bin/docgen
2022-02-24 17:54:56 +01:00
Anton Medvedev
25778d4464 Improve docgen 2021-11-08 22:44:15 +01:00
Anton Medvedev
def29291b5 docs: info about host() 2021-11-07 22:01:28 +01:00
Anton Medvedev
dcd7e75ee1 Rename getHost() to host() 2021-11-07 21:56:43 +01:00
Anton Medvedev
165574ddd2 Add fetch() func 2021-11-07 10:49:16 +01:00
Anton Medvedev
89f64ad955 Add selectedHosts() 2021-11-06 16:51:19 +01:00
Anton Medvedev
704af44600 Fix ProcessRunner 2021-11-05 15:47:54 +01:00
Anton Medvedev
0c7c0b1af6 Rename locateBinaryPath to which 2021-11-05 15:23:34 +01:00
Anton Medvedev
8cf0f2a5e4 Use shell option for runLocally func 2021-11-05 15:08:39 +01:00
Anton Medvedev
d8138040b0 Update ApiGen 2021-10-19 17:25:16 +02:00
Anton Medvedev
33ae3219a1 Format API Docs 2021-10-18 18:51:32 +02:00
Anton Medvedev
87dd668fa5 Compatability with php7 2021-10-11 22:18:05 +02:00
Anton Medvedev
0fc328bb96 Fix errors 2021-10-11 22:16:24 +02:00
Anton Medvedev
e55781b279 Various functions improvements 2021-10-11 22:07:22 +02:00
antonmedv
514b1ec453 Update docs with bin/docgen 2021-10-09 15:59:42 +00:00
Anton Medvedev
3216576680 Add docs 2021-09-26 15:25:58 +02:00
Anton Medvedev
8b2e55f3fe Remove docs/api.md, docs/recipe, docs/contrib 2021-09-24 14:42:32 +02:00
Anton Medvedev
463d95de78 Improve docgen 2021-08-31 20:15:06 +02:00
Anton Medvedev
2d9a9dcfaa
Remove vars (#2596) 2021-07-01 23:17:23 +03:00
Anton Medvedev
8f649331a5 Fix comment 2021-04-18 13:53:15 +02:00
Anton Medvedev
895762dc38 Move comment to api 2021-04-12 22:17:23 +02:00
Anton Medvedev
550049346d Update docs 2021-03-16 22:53:11 +01:00
Anton Medvedev
6b8cf3aae7 Better run command 2021-03-15 21:52:09 +01:00
Anton Medvedev
2205921bae Revert rename 2021-03-14 08:44:14 +01:00
Anton Medvedev
458d7b621f Rename fail() to onfail() 2021-03-13 22:03:49 +01:00
Anton Medvedev
b1f33b1734
Refactor shell arguments escaping (#2458)
Now, it should not matter what default shell is used on a server: zsh, fish. 
Deployer will automatically switch to bash (or to a user-specified shell).

Laso added a release verification task.
2021-03-13 23:50:38 +03:00
Anton Medvedev
b3e0e03d99
Add named arguments to run and runLocally (#2353)
* Add named arguments to run and runLocally

* Update docs
2020-12-18 19:40:09 +03:00
Anton Medvedev
2405241f2d Add timeout exceptions 2020-11-05 19:43:04 +01:00
Anton Medvedev
e47d8460f5 Update docs 2020-11-04 19:24:05 +01:00
Markus Staab
4040e1dd71
added @throws for run/runLocally and friends (#2264)
* added @throws for run/runLocally

* added `@throws` declarations

* generate docs
2020-11-03 20:28:24 +03:00
Markus Staab
55177c5b18
Fix fail() signature (#2261)
* added phpstan callable types

* Update src/Task/Task.php

* regenerated docs

* Update CHANGELOG.md

* update phpstan

* Restore Collection.php

* Restore Master.php

* Restore helpers.php

* Restore Task.php

* Update functions.php

* Update functions.php

* Update CHANGELOG.md

* regenerate docs
2020-11-02 12:13:57 +01:00
Anton Medvedev
2feb5c1247 Update docs 2020-10-25 14:20:03 +01:00
Anton Medvedev
5bc321f129 Update docs 2020-10-11 16:24:03 +02:00
Anton Medvedev
91c1d5fbec Docs updates 2020-10-11 01:52:36 +02:00
Anton Medvedev
6bd45d9223 Update docs 2020-10-09 23:21:03 +02:00
Anton Medvedev
47a193f9af
Add docgen 2020-10-02 01:11:13 +03:00
Anton Medvedev
6a32894218 Add comment on auto generated doc file 2020-09-30 15:35:44 +02:00
Anton Medvedev
3735d07794 Fix markdown gen 2020-09-30 09:29:02 +02:00
Anton Medvedev
c7cb9575fe Add api doc generation 2020-09-30 09:25:41 +02:00
Thomas
5e27256966
sort api reference headings (#2135)
* fixes MD012/no-multiple-blanks

fixes MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]

* fixes MD001/heading-increment

fixes MD001/heading-increment/header-increment: Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]

* sort headings alphabetically
2020-08-15 00:11:49 +03:00
Anton Medvedev
29a643b623 v7 2020-05-16 18:02:17 +03:00
Anton Medvedev
8472bd940d Add docs 2019-07-02 08:05:21 +03:00