Add example configuration to class PHPDoc

Author: sebastianfeldmann

src/Hook/Branch/Action/BlockFixupAndSquashCommits.php

@@ -27,17 +27,17 @@
  * This action blocks pushes that contain fixup! or squash! commits.
  * Just as a security layer, so you are not pushing stuff you wanted to autosquash.
  *
- * Configure like this:
- *
+ * Example configuration:
+ * <code>
  * {
- *    "action": "\\CaptainHook\\App\\Hook\\Branch\\Action\\BlockFixupAndSquashCommits",
- *    "options": {
- *      "blockSquashCommits": true,
- *      "blockFixupCommits": true,
- *      "protectedBranches": ["main", "master", "integration"]
- *    },
- *    "conditions": []
- *  }
+ *   "action": "CaptainHook.Branch.PreventPushOfFixupAndSquashCommits",
+ *   "options": {
+ *     "blockSquashCommits": true,
+ *     "blockFixupCommits": true,
+ *     "protectedBranches": ["main", "master", "integration"]
+ *   }
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>

src/Hook/Branch/Action/EnsureNaming.php

@@ -22,6 +22,20 @@
 /**
  * Class EnsureNaming
  *
+ * This Action makes sure you are on a branch that follows your naming conventions.
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "CaptainHook.Branch.EnsureNaming",
+ *   "options": {
+ *     "regex": "#feature/issue[0-9]+-.*#i",
+ *     "error": "Arr matey! Ye be on the wrong branch!",
+ *     "success": "All clear, Captain! Full speed ahead!",
+ *   }
+ * }
+ * </code>
+ *
  * @package CaptainHook
  * @author  Felix Edelmann <fxedel@gmail.com>
  * @link    https://github.com/captainhook-git/captainhook

src/Hook/Debug/Failure.php

@@ -18,7 +18,17 @@
 use SebastianFeldmann\Git\Repository;
 
 /**
- * Debug hook to test hook triggering that fails the hook execution
+ * Debug Failure
+ *
+ * Debug hook to test hook triggering, arguments, stdIn ect.
+ * Fails the hook execution and stops current the git operation.
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "CaptainHook.Debug.Fail"
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>

src/Hook/Debug/Success.php

@@ -17,7 +17,17 @@
 use SebastianFeldmann\Git\Repository;
 
 /**
- * Debug hook to test hook triggering that allows the hook to pass
+ * Debug Success
+ *
+ * Debug hook action to test hook triggering, arguments, stdIn etc.
+ * Does not crash the hook execution. The git operation will succeed.
+ *
+ * Example configuration:
+ * <code>
+ * {
+ *   "action": "CaptainHook.Debug.Ok"
+ * }
+ * </code>
  *
  * @package CaptainHook
  * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>