| 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 | Base class with properties needed to build the html files for classes/methods/properties/variables |
| 29 | */ |
| 30 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
| 31 | |
| 32 | class VariableDoc { |
| 33 | |
| 34 | /** |
| 35 | The name found in ast |
| 36 | @type {?String} |
| 37 | */ |
| 38 | |
| 39 | name = null; |
| 40 | |
| 41 | /** |
| 42 | The path between the html file and theConfig.destDir ( something like '../../../', depending of the folders tree ) |
| 43 | @type {?String} |
| 44 | */ |
| 45 | |
| 46 | rootPath = null; |
| 47 | |
| 48 | /** |
| 49 | The file name in witch the class/method/property/variable is declared, including path since theConfig.destDir |
| 50 | @type {?String} |
| 51 | */ |
| 52 | |
| 53 | file = null; |
| 54 | |
| 55 | /** |
| 56 | The line at witch the class/method/property/variable is declared - found in ast |
| 57 | @type {?String} |
| 58 | */ |
| 59 | |
| 60 | line = null; |
| 61 | |
| 62 | /** |
| 63 | The doc found in the comments of the class/method/property/variable |
| 64 | @type {?CommentsDoc} |
| 65 | */ |
| 66 | |
| 67 | commentsDoc = null; |
| 68 | |
| 69 | /** |
| 70 | The constructor. Seal the object, so it's not possible to add new properties to the object |
| 71 | */ |
| 72 | |
| 73 | constructor ( ) { } |
| 74 | |
| 75 | } |
| 76 | |
| 77 | export default VariableDoc; |
| 78 | |
| 79 | /* --- End of file --------------------------------------------------------------------------------------------------------- */ |
| 80 |