Update API docblock.
authorColeman Watts <coleman@civicrm.org>
Sat, 1 Feb 2020 16:44:44 +0000 (11:44 -0500)
committerCiviCRM <info@civicrm.org>
Wed, 16 Sep 2020 02:13:21 +0000 (19:13 -0700)
ext/afform/core/Civi/Api4/Afform.php

index 40dbbe7637615f714122216d0fbedd03a2820c4a..cb2f251be829983a8bd42e2ba3de5d9cbcbb368f 100644 (file)
@@ -7,7 +7,17 @@ use Civi\Api4\Generic\BasicBatchAction;
 use Civi\Api4\Generic\BasicGetFieldsAction;
 
 /**
- * User-configurable forms
+ * User-configurable forms.
+ *
+ * Afform stands for *The Affable Administrative Angular Form Framework*.
+ *
+ * This API provides actions for
+ *   1. **_Managing_ forms:**
+ *      The `create`, `get`, `save`, `update`, & `revert` actions read/write form html & json files.
+ *   2. **_Using_ forms:**
+ *      The `prefill` and `submit` actions are used for preparing forms and processing submissions.
+ *
+ * @see https://lab.civicrm.org/extensions/afform
  * @package Civi\Api4
  */
 class Afform extends AbstractEntity {