summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCyrille Bollu <cyrpub@bollu.be>2019-10-07 15:58:45 +0200
committerRobin Appelman <robin@icewind.nl>2020-10-13 23:51:41 +0200
commit5a5d9ce3aa121342516372cf2d9abd76440aac22 (patch)
tree1028eb442650872c1d6d810b10735a87154d1b14
parent3421661ee95d1357b8ad0cc5183aa88e62aed04e (diff)
DOC: Adds documentation to serverData mixins
Signed-off-by: Cyrille Bollu <cyrpub@bollu.be>
-rw-r--r--src/mixins/serverData.js16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/mixins/serverData.js b/src/mixins/serverData.js
index 1fdcbfd1..f1674d32 100644
--- a/src/mixins/serverData.js
+++ b/src/mixins/serverData.js
@@ -20,6 +20,22 @@
*
*/
+/*
+ * This file provides global methods for using the serverData structure
+ * the serverData structure's data are initialy found in a DOM element
+ * provided by the server.
+ *
+ * It may contain the following information:
+ * - account (only in 'OStatus.vue'): The account that the user wants to follow
+ * - cliUrl:
+ * - cloudAddress:
+ * - firstrun:
+ * - isAdmin:
+ * - local (only in 'OStatus.vue'): The local part of the account that the user wants to follow
+ * - public: False when the page is accessed by an authenticated user. True otherwise.
+ * - setup:
+ */
+
export default {
computed: {
serverData: function() {