Commit 143448b1 authored by Tristan Cavelier's avatar Tristan Cavelier

jobRules docstrings are now well formated

parent 5877224e
...@@ -81,8 +81,8 @@ var jobRules = (function(spec) { ...@@ -81,8 +81,8 @@ var jobRules = (function(spec) {
/** /**
* Returns an action string to show what to do if we want to add a job. * Returns an action string to show what to do if we want to add a job.
* @method validateJobAccordingToJob * @method validateJobAccordingToJob
* @param job1 {object} The current job. * @param {object} job1 The current job.
* @param job2 {object} The new job. * @param {object} job2 The new job.
* @return {string} The action string. * @return {string} The action string.
*/ */
Object.defineProperty(that,"validateJobAccordingToJob",{ Object.defineProperty(that,"validateJobAccordingToJob",{
...@@ -98,10 +98,10 @@ var jobRules = (function(spec) { ...@@ -98,10 +98,10 @@ var jobRules = (function(spec) {
/** /**
* Adds a rule the action rules. * Adds a rule the action rules.
* @method addActionRule * @method addActionRule
* @param method1 {string} The action label from the current job. * @param {string} method1 The action label from the current job.
* @param ongoing {boolean} Is this action is on going or not? * @param {boolean} ongoing Is this action is on going or not?
* @param method2 {string} The action label from the new job. * @param {string} method2 The action label from the new job.
* @param rule {function} The rule that return an action string. * @param {function} rule The rule that return an action string.
*/ */
Object.defineProperty(that,"addActionRule",{ Object.defineProperty(that,"addActionRule",{
configurable:false,enumerable:false,writable:false,value: configurable:false,enumerable:false,writable:false,value:
...@@ -117,9 +117,9 @@ var jobRules = (function(spec) { ...@@ -117,9 +117,9 @@ var jobRules = (function(spec) {
/** /**
* Adds a rule the compare rules. * Adds a rule the compare rules.
* @method addCompareRule * @method addCompareRule
* @param method1 {string} The action label from the current job. * @param {string} method1 The action label from the current job.
* @param method2 {string} The action label from the new job. * @param {string} method2 The action label from the new job.
* @param rule {function} The rule that return a boolean * @param {function} rule The rule that return a boolean
* - true if job1 and job2 can be compared, else false. * - true if job1 and job2 can be compared, else false.
*/ */
Object.defineProperty(that,"addCompareRule",{ Object.defineProperty(that,"addCompareRule",{
......
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