UNPKG

short-jsdoc

Version:

short and simple jsdoc Object Oriented syntax format and implementation

github.com/cancerberoSgx/short-jsdoc

cancerberoSgx/short-jsdoc

61 lines (42 loc) • 2.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// @module problem1 This is a description of planet earth city from the point of view of an alien observing us from a space ship. //@class TerranObject // @class Person @extends TerranObject //@class List This is just a semantic alias for javascript Array. @extends Array //@class Map This is just a semantic alias for javascript Object. @extends Object /*@class Building @extends TerranObject */ //@class Hospital @extends Building //@constructor Neque porro quisquam est qui _dolorem_ *ipsum* quia dolor sit amet, consectetur, adipisci velit... //@param {Number} availableBeds //Neque porro quisquam est qui _dolorem_ *ipsum* quia dolor sit amet, consectetur, adipisci velit... //@method getActiveDoctors @returns {List<Doctor>} the currently active doctors in this hospital //@property {Array<Person>} todayIngresedPatients all the patiens that entered this hospital today // @class Doctor @extend Person // @property {Map<String,MedicalTopic>} skills /* @class MedicalTopic Lorem *ipsum* dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat *cupidatat* non proident, sunt in culpa qui officia deserunt mollit anim id est laborum @method beUsed Lorem *ipsum* dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat *cupidatat* non proident, sunt in culpa qui officia deserunt mollit anim id est laborum @throws {MedicalException} if there is any medical issue stuff... @param {Number} amount Excepteur sint occaecat *cupidatat* @return {Array<MedicalTopic>} @class MedicalException @extends Error */