Commit 656f1f96 authored by Tristan Cavelier's avatar Tristan Cavelier

Add method doc, rename vars to make them more explicit

parent 3c3d98e5
...@@ -76,7 +76,7 @@ ...@@ -76,7 +76,7 @@
array[i].app = 'text_editor'; array[i].app = 'text_editor';
} else { } else {
array[i].icon = mime.icon; array[i].icon = mime.icon;
array[i].app = mime.pref || mime.app; array[i].app = mime.preferred_application || mime.application;
} }
// dates // dates
// FIXME : we can have 2012/1/1 12:5 // FIXME : we can have 2012/1/1 12:5
......
...@@ -188,15 +188,17 @@ ...@@ -188,15 +188,17 @@
} }
}; };
priv.mime_object = { priv.mime_object = {
// <pref> if the name of the app set in preferences. // <preferred_application> if the name of the app set in
// If pref does not exist it means that the extension is very // preferences.
// specific, so <app> is called instead of the default editor. // If <preferred_application> does not exist it means that the
// extension is very specific, so <application> is called instead of
// the default editor.
// NOTE : the icon may be set in the app in app_object. // NOTE : the icon may be set in the app in app_object.
html:{pref:'text_editor',app:'elrte', html:{preferred_application:'text_editor',application:'elrte',
icon:'<i class="icon-font"></i>'}, icon:'<i class="icon-font"></i>'},
svg:{pref:'img_editor',app:'svg-edit', svg:{preferred_application:'img_editor',application:'svg-edit',
icon:'<i class="icon-pencil"></i>'}, icon:'<i class="icon-pencil"></i>'},
jqs:{app:'jquery-sheet', jqs:{application:'jquery-sheet',
icon:'<i class="icon-signal"></i>'} icon:'<i class="icon-signal"></i>'}
}; };
priv.data_object = { priv.data_object = {
...@@ -559,6 +561,11 @@ ...@@ -559,6 +561,11 @@
} }
}; };
/**
* Get current activity.
* @method getActivity
* @return {array} A list of current states for each current activities.
*/
that.getActivity = function () { that.getActivity = function () {
var activity = priv.jio.getJobArray (); var activity = priv.jio.getJobArray ();
var lastfailure = that.getLastFailure(); var lastfailure = that.getLastFailure();
...@@ -613,6 +620,11 @@ ...@@ -613,6 +620,11 @@
return res; return res;
}; };
/**
* Returns the last job failure.
* @method getLastFailure
* @return {object} The last failure.
*/
that.getLastFailure = function () { that.getLastFailure = function () {
return priv.lastfailure; return priv.lastfailure;
}; };
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment