Closed (fixed)
Project:
Hexagon
Version:
7.x-2.0-alpha3
Component:
Code
Priority:
Minor
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
9 May 2011 at 20:55 UTC
Updated:
23 May 2011 at 21:02 UTC
Jump to comment: Most recent file
This is just to simplify the code a bit. I thought it was needed in previous versions but it's just unused junk.
hex_plugin_list() returns a list of plug-in keys based on a "set" or filter.
Here's the current code comments:
/**
* Returns a list of plug-in's.
*
* The set can be used to filter the output. Use ".active" for enabled
* plug-ins. The ".ENABLER" is what enabled the plug-in. It's typically the
* theme but it can also be a module when the plug-in type is a compatibility
* plug-in. The ".TYPE" is determined by the .pinfo "plugin.type" setting. The
* "HOST" is the theme where the plug-in is hosted and ".active.locked" are
* for plug-ins that cannot be disabled through the theme settings form
* because it is a required plug-in.
*
* - all
* - all.active
* - all.active.locked
* - all.active.ENABLER
* - all.active.ENABLER.locked
* - all.TYPE
* - all.TYPE.active
* - all.TYPE.active.locked
* - all.TYPE.active.ENABLER
* - all.TYPE.active.ENABLER.locked
*
* - HOST
* - HOST.active
* - HOST.active.locked
* - HOST.active.ENABLER
* - HOST.active.ENABLER.locked
* - HOST.TYPE
* - HOST.TYPE.active
* - HOST.TYPE.active.locked
* - HOST.TYPE.active.ENABLER
* - HOST.TYPE.active.ENABLER.locked
*
* When a plug-in requires more than one module and its type is a
* compatibility plug-in, the ENABLER will be set in multiple forms. Keep in
* mind that compatibility plug-ins are automatically enabled triggered by the
* state of enabled modules. Example plug-in .pinfo file:
*
* plugin.type = compatibility
*
* module.dependencies[] = overlay
* module.dependencies[] = toolbar
*
* Here is a partial list of possible $set's which would list the plug-in
* when active:
*
* - all.active.overlay+toolbar
* - all.active.overlay
* - all.active.toolbar
* - all.compatibility
* - all.compatibility.active.overlay+toolbar
* - all.compatibility.active.overlay
* - all.compatibility.active.toolbar
*
* In all other cases, ENABLER will be the theme that enabled the plug-in.
*
* @param $set
* Used to filter the output. Note that none of the sets will include
* plug-in's hosted in disabled themes.
*/
And the comments for this patch explaining what it does now:
/**
* Returns a list of plug-in's.
*
* The set can be used to filter the output. Use "active" for enabled plug-ins,
* "TYPE" is for the plug-in type determined by the .pinfo "plugin.type" key
* and the "HOST" is the theme where the plug-in is hosted.
*
* - all
* - all.active
* - all.TYPE
* - all.TYPE.active
*
* - HOST
* - HOST.active
* - HOST.TYPE
* - HOST.TYPE.active
*
* @param $set
* Used to filter the output. Note that none of the sets will include
* plug-in's hosted in disabled themes.
*/
The above is all that's necessary.
| Comment | File | Size | Author |
|---|---|---|---|
| #1 | patch_commit_d08770dc03d8.patch | 5.12 KB | dvessel |
Comments
Comment #1
dvessel commented