File : TypeDescription.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
/* ------------------------------------------------------------------------------------------------------------------------- */
27
/**
28
A class with properties to document params, type and returns
29
*/
30
/* ------------------------------------------------------------------------------------------------------------------------- */
31
32
class TypeDescription {
33
34
    /**
35
    The name of the param
36
    @type {String}
37
    */
38
39
    name = null;
40
41
    /**
42
    The type of the param or return
43
    @type {?String}
44
    */
45
46
    type = null;
47
48
    /**
49
    The description of the param or return
50
    @type {?String}
51
    */
52
53
    desc = null;
54
55
    /**
56
    The constructor
57
    */
58
59
    constructor ( ) {
60
        Object.seal ( this );
61
    }
62
63
}
64
65
export default TypeDescription;
66
67
/* --- End of file --------------------------------------------------------------------------------------------------------- */
68