File : MethodOrPropertyDoc.js

1
/*
2
Copyright - 2021 - wwwouaiebe - Contact: https://www.ouaie.be/
3
4
This  program is free software;
5
you can redistribute it and/or modify it under the terms of the
6
GNU General Public License as published by the Free Software Foundation;
7
either version 3 of the License, or any later version.
8
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
GNU General Public License for more details.
13
14
You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
*/
18
/*
19
Changes:
20
    - v1.0.0:
21
        - created
22
Doc reviewed 20211111
23
*/
24
/* ------------------------------------------------------------------------------------------------------------------------- */
25
26
import VariableDoc from './VariableDoc.js';
27
28
/* ------------------------------------------------------------------------------------------------------------------------- */
29
/**
30
A class with properties needed to build the html files for methods/properties
31
*/
32
/* ------------------------------------------------------------------------------------------------------------------------- */
33
34
class MethodOrPropertyDoc extends VariableDoc {
35
36
    /**
37
    A flag indicating that the method or property is static - found in ast
38
    @type {?boolean}
39
    */
40
41
    static = null;
42
43
    /**
44
    A flag indicating that the method is async
45
    @type {?boolean}
46
    */
47
48
    async = null;
49
50
    /**
51
    A flag indicating that the method or property is private - found in ast
52
    @type {?boolean}
53
    */
54
55
    private = null;
56
57
    /**
58
    The kind of method ( = 'get', 'set' or 'constructor' ) - found in ast
59
    @type {?String}
60
    */
61
62
    kind = null;
63
64
    /**
65
    The type ( = 'method' or 'property' ) - found in ast
66
    @type {?String}
67
    */
68
69
    isA = null;
70
71
    /**
72
    The params names found in ast
73
    @type {?Array.<String>}
74
    */
75
76
    params = null;
77
}
78
79
export default MethodOrPropertyDoc;
80
81
/* --- End of file --------------------------------------------------------------------------------------------------------- */
82