diff options
| author | Cyrille Bollu <cyrpub@bollu.be> | 2019-10-25 13:35:38 +0200 |
|---|---|---|
| committer | Robin Appelman <robin@icewind.nl> | 2020-10-13 23:54:16 +0200 |
| commit | 1e378654dc2c23ade910d259bac9293a9c58ac62 (patch) | |
| tree | f5d8ebe1bcea73c79ab1b94bc40d1825bbd569b3 | |
| parent | f0970a19d8ea3e9a4888f2dc28998b536009b21f (diff) | |
Adds doc to some mixins
Signed-off-by: Cyrille Bollu <cyrpub@bollu.be>
| -rw-r--r-- | src/mixins/accountMixins.js | 2 | ||||
| -rw-r--r-- | src/mixins/serverData.js | 14 |
2 files changed, 15 insertions, 1 deletions
diff --git a/src/mixins/accountMixins.js b/src/mixins/accountMixins.js index cb312420..5f1a52fb 100644 --- a/src/mixins/accountMixins.js +++ b/src/mixins/accountMixins.js @@ -7,6 +7,8 @@ * * @file provides global account related methods * + * @mixin + * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the diff --git a/src/mixins/serverData.js b/src/mixins/serverData.js index cf0be10c..7bd6ec06 100644 --- a/src/mixins/serverData.js +++ b/src/mixins/serverData.js @@ -3,6 +3,8 @@ * * @file Provides global methods for using the serverData structure. * + * @mixin + * * @author Julius Härtl <jus@bitgrid.net> * * @license GNU AGPL version 3 or any later version @@ -24,7 +26,17 @@ export default { computed: { - serverData: function() { + /** @description Returns the serverData object + * @property {String} account - The account that the user wants to follow (Only in 'OStatus.vue') + * @property cliUrl + * @property cloudAddress + * @property firstrun + * @property isAdmin + * @property {String} local - The local part of the account that the user wants to follow + * @property {boolean} public - False when the page is accessed by an authenticated user. True otherwise + * @property setup + */ + serverData() { return this.$store.getters.getServerData }, hostname() { |