Skip to content

Commit

Permalink
(NFC) Update docblock in CRM_Core_Resources_Common
Browse files Browse the repository at this point in the history
  • Loading branch information
totten committed Oct 2, 2020
1 parent 8eb00bd commit 96622c8
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions CRM/Core/Resources/Common.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,22 @@ class CRM_Core_Resources_Common {
const REGION = 'html-header';

/**
* A "basic" bundle has an
* Create a "basic" (generic) bundle.
*
* The bundle goes through some lifecycle events (like `hook_alterBundle`).
*
* To define default content for a basic bundle, you may either give an
* `$init` function or subscribe to `hook_alterBundle`.
*
* @param string $name
* Symbolic name of the bundle.
* @param callable|NULL $init
* Optional initialization function. Populate default resources.
* ie `function($bundle): void`
* Signature: `function($bundle): void`
* Example: `function myinit($b) { $b->addScriptFile(...)->addStyleFile(...); }`
* @param string|string[] $types
* List of resource-types to permit in this bundle. NULL for a default list.
* Ex: ['styleFile', 'styleUrl']
* Example: ['styleFile', 'styleUrl']
* The following aliases are allowed: '*all*', '*default*', '*script*', '*style*'
* @return CRM_Core_Resources_Bundle
*/
Expand Down

0 comments on commit 96622c8

Please sign in to comment.