Adds doc to some mixins

Signed-off-by: Cyrille Bollu <cyrpub@bollu.be>
pull/793/head
Cyrille Bollu 2019-10-25 13:35:38 +02:00 zatwierdzone przez Robin Appelman
rodzic f0970a19d8
commit 1e378654dc
2 zmienionych plików z 15 dodań i 1 usunięć

Wyświetl plik

@ -7,6 +7,8 @@
* *
* @file provides global account related methods * @file provides global account related methods
* *
* @mixin
*
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as * it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the * published by the Free Software Foundation, either version 3 of the

Wyświetl plik

@ -3,6 +3,8 @@
* *
* @file Provides global methods for using the serverData structure. * @file Provides global methods for using the serverData structure.
* *
* @mixin
*
* @author Julius Härtl <jus@bitgrid.net> * @author Julius Härtl <jus@bitgrid.net>
* *
* @license GNU AGPL version 3 or any later version * @license GNU AGPL version 3 or any later version
@ -24,7 +26,17 @@
export default { export default {
computed: { 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 return this.$store.getters.getServerData
}, },
hostname() { hostname() {