-
Notifications
You must be signed in to change notification settings - Fork 0
/
export-class-PropertyDescription-true.txt
514 lines (393 loc) · 17.7 KB
/
export-class-PropertyDescription-true.txt
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
@startuml
set namespaceSeparator none
abstract class handle {
-- Events --
ObjectBeingDestroyed
}
class uint32 {
-- Methods --
{method} + varargout = uint32(varargin)
}
package matdoc {
package matdoc.enums {
enum matdoc.enums.AccessLevel {
-- Enumeration Values --
None
Public
Protected
Private
Custom
-- Methods --
{method} + e = AccessLevel(varargin)
.. Hidden ..
{method} + varargout = colon(varargin)
.. Public ..
{method} + lhs1 = char(rhs1)
{method} + isEqual = eq(this, other)
{method} + isEqual = ne(this, other)
.. Static ..
{method} {static} + enum = from(val)
{method} {static} + enum = fromNum(val)
{method} {static} + enum = fromStr(val)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
}
}
package matdoc.meta {
class matdoc.meta.Class {
-- Properties --
.. Constant ..
{field} {static} + IDENT < matdoc.uml.super.Base
Number if spaces for each identation level in the UML diagram
Help for matdoc.meta.Class.IDENT is inherited from superclass MATDOC.UML.SUPER.BASE
.. Protected ..
{field} # Configuration < matdoc.super.WithMetaObjProps
The handle to the export configuration
Help for matdoc.meta.Class/Configuration is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # Parent < matdoc.super.WithMetaObjProps
the parent object
Help for matdoc.meta.Class/Parent is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # UmlRoot < matdoc.super.WithMetaObjProps
Handle to the parent matdoc.Documentation class
Help for matdoc.meta.Class/UmlRoot is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
.. SetAccess = Protected ..
{field} + Abstract
Is the class abstract?
{field} + Alias < matdoc.super.WithAlias
A distince name alias of this class which is used in the UML
diagram as alias to deal with packages and classes which might
have the same name
Help for matdoc.meta.Class/Alias is inherited from superclass MATDOC.SUPER.WITHALIAS
{field} + ConstructOnLoad
Construct OnLoad
{field} + Constructor
Handle to the matdoc.meta.Method instance representing the
constructor method
{field} + ContainingPackage
ContainingPackage
{field} + Description
Class description
{field} + DetailedDescription
Detailed class description
{field} + EnumerationMemberList
The list of EnumerationMembers
{field} + EventList
The list of events
{field} + HandleCompatible
Is the class a handle class?
{field} + hasAbstractMembers
Flag if any of the defined properties or methods are abstract
{field} + Hidden
Is the class hidden?
{field} + InferiorClasses
InferiorClasses
{field} + InheritationRelations
The inheritation relation ships
{field} + isBuiltIn
If true the wrapped class is a built in matlab class
{field} + isUnitTest
Flag if the class is within matlabs unit testing framework or is
inheritated from it
{field} + metaObj < matdoc.meta.super.Base
the actual wrapped meta object (meta.package, meta.class,
meta.method, meta.property, etc.)
Help for matdoc.meta.Class/metaObj is inherited from superclass MATDOC.META.SUPER.BASE
{field} + MethodList
The list of methods
{field} + MethodListFlattened
A complete list of methods incl the ones inheritated from
other classes
{field} + Name
The name of Class
{field} + NameRaw < matdoc.super.WithNameRaw
The raw name of the class, package, etc. without the leading package or
namepace string
Help for matdoc.meta.Class/NameRaw is inherited from superclass MATDOC.SUPER.WITHNAMERAW
{field} + PropertyList
The list of properties
{field} + PropertyListFlattened
A complete list of properties incl the ones inheritated from
other classes
{field} + Sealed
Is the class sealed?
{field} + SortedMethodList
It cotains a Nx2 cell array. The first column holds the
category (categoryUML property) and the second column the
actual cell array of handles to the meta classes.
N = number of unique categories.
{field} + SortedPropertyList
It cotains a Nx2 cell array. The first column holds the
category (categoryUML property) and the second column the
actual cell array of handles to the meta classes.
N = number of unique categories.
{field} + SuperclassList
The list of super classes
{field} + SuperclassListFlattened
A complete list of super classes incl. nested inheritated classes
-- Methods --
{method} + this = Class(metaObj, parent)
.. Protected ..
{method} # umlStr = getPlantUmlEnumerationValues(this, ident_) < matdoc.uml.Class
{method} # umlStr = getPlantUmlEvents(this, ident_) < matdoc.uml.Class
{method} # umlStr = getPlantUmlMethods(this, ident_) < matdoc.uml.Class
{method} # umlStr = getPlantUmlProperties(this, ident_) < matdoc.uml.Class
{method} # getSortedMethodList(this)
{method} # getSortedPropertyList(this)
{method} # val = getSuperclassListFlattened(this)
{method} # setAlias(this) < matdoc.super.WithAlias
{method} # setNameRaw(this) < matdoc.super.WithNameRaw
{method} # walkMeta(this)
.. Public ..
{method} + is_eq = eq(this, other) < matdoc.meta.super.Base
{method} + umlStr = getPlantUML(this, ident_) < matdoc.uml.Class
{method} + umlStr = getPlantUmlInheritanceRelation(this, ident_) < matdoc.uml.Class
{method} + is_ne = ne(this, other) < matdoc.meta.super.Base
{method} + [B, IX] = sort(this, dim, mode) < matdoc.meta.super.Base
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
package matdoc.meta.super {
abstract class matdoc.meta.super.Base {
-- Properties --
.. Abstract SetAccess = Protected ..
{field} {abstract} + Name
The name of the meta object
.. Protected ..
{field} # Configuration < matdoc.super.WithMetaObjProps
The handle to the export configuration
Help for matdoc.meta.super.Base/Configuration is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # Parent < matdoc.super.WithMetaObjProps
the parent object
Help for matdoc.meta.super.Base/Parent is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # UmlRoot < matdoc.super.WithMetaObjProps
Handle to the parent matdoc.Documentation class
Help for matdoc.meta.super.Base/UmlRoot is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
.. SetAccess = Protected ..
{field} + metaObj
the actual wrapped meta object (meta.package, meta.class,
meta.method, meta.property, etc.)
-- Methods --
{method} + this = Base(metaObj, parent)
.. Abstract Protected ..
{method} {abstract} # walkMeta(this)
.. Public ..
{method} + is_eq = eq(this, other)
{method} + is_ne = ne(this, other)
{method} + [B, IX] = sort(this, dim, mode)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
abstract class matdoc.meta.super.Container {
-- Properties --
.. Abstract SetAccess = Protected ..
{field} {abstract} + Name < matdoc.meta.super.Base
The name of the meta object
Help for matdoc.meta.super.Container/Name is inherited from superclass MATDOC.META.SUPER.BASE
.. Protected ..
{field} # Configuration < matdoc.super.WithMetaObjProps
The handle to the export configuration
Help for matdoc.meta.super.Container/Configuration is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # Parent < matdoc.super.WithMetaObjProps
the parent object
Help for matdoc.meta.super.Container/Parent is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # UmlRoot < matdoc.super.WithMetaObjProps
Handle to the parent matdoc.Documentation class
Help for matdoc.meta.super.Container/UmlRoot is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
.. SetAccess = Protected ..
{field} + Alias < matdoc.super.WithAlias
A distince name alias of this class which is used in the UML
diagram as alias to deal with packages and classes which might
have the same name
Help for matdoc.meta.super.Container/Alias is inherited from superclass MATDOC.SUPER.WITHALIAS
{field} + metaObj < matdoc.meta.super.Base
the actual wrapped meta object (meta.package, meta.class,
meta.method, meta.property, etc.)
Help for matdoc.meta.super.Container/metaObj is inherited from superclass MATDOC.META.SUPER.BASE
{field} + NameRaw < matdoc.super.WithNameRaw
The raw name of the class, package, etc. without the leading package or
namepace string
Help for matdoc.meta.super.Container/NameRaw is inherited from superclass MATDOC.SUPER.WITHNAMERAW
-- Methods --
{method} + this = Container(metaObj, parent)
.. Protected ..
{method} # setAlias(this) < matdoc.super.WithAlias
{method} # setNameRaw(this) < matdoc.super.WithNameRaw
{method} # walkMeta(this)
.. Public ..
{method} + is_eq = eq(this, other) < matdoc.meta.super.Base
{method} + is_ne = ne(this, other) < matdoc.meta.super.Base
{method} + [B, IX] = sort(this, dim, mode) < matdoc.meta.super.Base
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
}
}
package matdoc.super {
class matdoc.super.Base {
-- Properties --
.. Protected ..
{field} # Configuration < matdoc.super.WithMetaObjProps
The handle to the export configuration
Help for matdoc.super.Base/Configuration is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # Parent < matdoc.super.WithMetaObjProps
the parent object
Help for matdoc.super.Base/Parent is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # UmlRoot < matdoc.super.WithMetaObjProps
Handle to the parent matdoc.Documentation class
Help for matdoc.super.Base/UmlRoot is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
-- Methods --
{method} + this = Base(parent)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
abstract class matdoc.super.WithAlias {
-- Properties --
.. Abstract SetAccess = Protected ..
{field} {abstract} + Name
The name of the meta object
{field} {abstract} + NameRaw
The raw name of the class, package, etc. without the leading package or
namepace string
.. SetAccess = Protected ..
{field} + Alias
A distince name alias of this class which is used in the UML
diagram as alias to deal with packages and classes which might
have the same name
-- Methods --
{method} + obj = WithAlias()
.. Protected ..
{method} # setAlias(this)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
class matdoc.super.WithMetaObjProps {
-- Properties --
.. Protected ..
{field} # Configuration
The handle to the export configuration
{field} # Parent
the parent object
{field} # UmlRoot
Handle to the parent matdoc.Documentation class
-- Methods --
{method} + obj = WithMetaObjProps()
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
abstract class matdoc.super.WithNameRaw {
-- Properties --
.. Abstract SetAccess = Protected ..
{field} {abstract} + Name
The name of the meta object
.. SetAccess = Protected ..
{field} + NameRaw
The raw name of the class, package, etc. without the leading package or
namepace string
-- Methods --
{method} + obj = WithNameRaw()
.. Protected ..
{method} # setNameRaw(this)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
}
package matdoc.uml {
class matdoc.uml.Class {
-- Properties --
.. Constant ..
{field} {static} + IDENT < matdoc.uml.super.Base
Number if spaces for each identation level in the UML diagram
Help for matdoc.uml.Class.IDENT is inherited from superclass MATDOC.UML.SUPER.BASE
.. Protected ..
{field} # Configuration < matdoc.super.WithMetaObjProps
The handle to the export configuration
Help for matdoc.uml.Class/Configuration is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # Parent < matdoc.super.WithMetaObjProps
the parent object
Help for matdoc.uml.Class/Parent is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # UmlRoot < matdoc.super.WithMetaObjProps
Handle to the parent matdoc.Documentation class
Help for matdoc.uml.Class/UmlRoot is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
-- Methods --
{method} + obj = Class()
.. Protected ..
{method} # umlStr = getPlantUmlEnumerationValues(this, ident_)
{method} # umlStr = getPlantUmlEvents(this, ident_)
{method} # umlStr = getPlantUmlMethods(this, ident_)
{method} # umlStr = getPlantUmlProperties(this, ident_)
.. Public ..
{method} + umlStr = getPlantUML(this, ident_)
{method} + umlStr = getPlantUmlInheritanceRelation(this, ident_)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
package matdoc.uml.super {
abstract class matdoc.uml.super.Base {
-- Properties --
.. Constant ..
{field} {static} + IDENT
Number if spaces for each identation level in the UML diagram
.. Protected ..
{field} # Configuration < matdoc.super.WithMetaObjProps
The handle to the export configuration
Help for matdoc.uml.super.Base/Configuration is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # Parent < matdoc.super.WithMetaObjProps
the parent object
Help for matdoc.uml.super.Base/Parent is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
{field} # UmlRoot < matdoc.super.WithMetaObjProps
Handle to the parent matdoc.Documentation class
Help for matdoc.uml.super.Base/UmlRoot is inherited from superclass MATDOC.SUPER.WITHMETAOBJPROPS
-- Methods --
{method} + obj = Base()
.. Abstract ..
{method} {abstract} + umlStr = getPlantUML(this, ident_) < matdoc.uml.super.WithPlantUML
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
abstract class matdoc.uml.super.WithPlantUML {
-- Methods --
{method} + obj = WithPlantUML()
.. Abstract ..
{method} {abstract} + umlStr = getPlantUML(this, ident_)
.. Static Hidden ..
{method} {static} + E = empty(varargin)
-- Events --
ObjectBeingDestroyed < handle
}
}
}
}
matdoc.enums.AccessLevel --|> uint32
matdoc.meta.Class ..|> matdoc.meta.super.Container
matdoc.meta.Class --|> matdoc.uml.Class
matdoc.meta.super.Base --|> matdoc.super.Base
matdoc.meta.super.Container ..|> matdoc.meta.super.Base
matdoc.meta.super.Container ..|> matdoc.super.WithNameRaw
matdoc.meta.super.Container ..|> matdoc.super.WithAlias
matdoc.super.Base --|> matdoc.super.WithMetaObjProps
matdoc.super.WithAlias ..|> handle
matdoc.super.WithMetaObjProps ..|> handle
matdoc.super.WithNameRaw ..|> handle
matdoc.uml.Class ..|> matdoc.uml.super.Base
matdoc.uml.super.Base --|> matdoc.super.WithMetaObjProps
matdoc.uml.super.Base ..|> matdoc.uml.super.WithPlantUML
matdoc.uml.super.WithPlantUML ..|> handle
@enduml