| 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 found in the comments and needed to build the html files for |
| 29 | classes/methods/properties/variables |
| 30 | */ |
| 31 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
| 32 | |
| 33 | class CommentsDoc { |
| 34 | |
| 35 | /** |
| 36 | The description of the commented class/method/property/variable |
| 37 | @type {?String} |
| 38 | */ |
| 39 | |
| 40 | desc = null; |
| 41 | |
| 42 | /** |
| 43 | The sample of the commented class/method/property/variable |
| 44 | @type {?String} |
| 45 | */ |
| 46 | |
| 47 | sample = null; |
| 48 | |
| 49 | /** |
| 50 | The type of the commented variable |
| 51 | @type {?String} |
| 52 | */ |
| 53 | |
| 54 | type = null; |
| 55 | |
| 56 | /** |
| 57 | The params of the commented method |
| 58 | @type {?Array.<TypeDescription>} |
| 59 | */ |
| 60 | |
| 61 | params = null; |
| 62 | |
| 63 | /** |
| 64 | The returns type of the commented method |
| 65 | @type {TypeDescription} |
| 66 | */ |
| 67 | |
| 68 | returns = null; |
| 69 | |
| 70 | /** |
| 71 | A flag indicating that the class/method/property/variable have to be ignored |
| 72 | @type {Boolean} |
| 73 | */ |
| 74 | |
| 75 | ignore = null; |
| 76 | |
| 77 | /** |
| 78 | The constructor |
| 79 | */ |
| 80 | |
| 81 | constructor ( ) { |
| 82 | Object.seal ( this ); |
| 83 | } |
| 84 | |
| 85 | } |
| 86 | |
| 87 | export default CommentsDoc; |
| 88 | |
| 89 | /* --- End of file --------------------------------------------------------------------------------------------------------- */ |
| 90 |