From f87604e65556d79883509c250d5d36b84b812fbb Mon Sep 17 00:00:00 2001
From: Mathis Neumann <mathis@simpletechs.net>
Date: Mon, 11 Jul 2016 18:47:50 +0200
Subject: [PATCH] improve documentation
---
app/services/changelog-parser.js | 22 ++++++++++++++++++++++
app/services/changelog-queue.js | 8 ++++++++
app/services/visualisation-events.js | 1 -
3 files changed, 30 insertions(+), 1 deletion(-)
diff --git a/app/services/changelog-parser.js b/app/services/changelog-parser.js
index ca36fb9..b802622 100644
--- a/app/services/changelog-parser.js
+++ b/app/services/changelog-parser.js
@@ -1,13 +1,35 @@
import Ember from 'ember';
// TODO: update cytoscape instead of complete rerender
+/**
+ * The changelog parser takes a changelog (as a plain JS object) and updates the internal
+ * state of the Ember Data store automatically. Supports CREATE, UPDATE, DELETE and APPEND operations
+ *
+ * @class ChangelogParserService
+ * @extends {Ember.Service}
+ */
export default Ember.Service.extend({
store: Ember.inject.service(),
+
+ /**
+ * Parse a list of changelogs
+ * @param {Array} changelogs List of changelogs, as plain JavaScript objects
+ * @method parse
+ * @public
+ */
parse(changelogs) {
this.debug('store', this.get('store'));
this.debug('parsing changelogs', changelogs);
changelogs.forEach(this.parseSingle.bind(this));
},
+
+ /**
+ * Parse a single changelog
+ *
+ * @param {Object} changelog changelog as plain JavaScript object, see backend documentation for data structure
+ * @method parseSingle
+ * @public
+ */
parseSingle(changelog) {
const operation = this.get(`operations.${changelog.operation}`);
if(!operation) {
diff --git a/app/services/changelog-queue.js b/app/services/changelog-queue.js
index 435e2c4..d6ae337 100644
--- a/app/services/changelog-queue.js
+++ b/app/services/changelog-queue.js
@@ -1,5 +1,13 @@
import Ember from 'ember';
+/**
+ * Stores changelogs which were received via ChangelogStreamService and applies the {ChangelogParserService} if triggered externally
+ *
+ * @class ChangelogQueueService
+ * @extends {Ember.Service}
+ * @uses ChangelogStreamService
+ * @uses ChangelogParserService
+ */
export default Ember.Service.extend({
changelogParser: Ember.inject.service(),
_private: {
diff --git a/app/services/visualisation-events.js b/app/services/visualisation-events.js
index 0f6ba0b..c5bd173 100644
--- a/app/services/visualisation-events.js
+++ b/app/services/visualisation-events.js
@@ -8,7 +8,6 @@ import Ember from 'ember';
*
* @class VisualisationEventsService
* @extends {Ember.Service}
- * @public
*/
export default Ember.Service.extend(Ember.Evented, {
/**
--
GitLab