1 | /**
|
2 | * TypeScript interface describing a Universal Reference YAML documentation file,
|
3 | * as defined by typescript.schema.json.
|
4 | *
|
5 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.PageViewModel` in DocFX.
|
6 | */
|
7 | export interface IYamlApiFile {
|
8 | /**
|
9 | * The items contained in this file.
|
10 | *
|
11 | * NOTE: Corresponds to `ExceptionInfo.Items` in DocFX.
|
12 | */
|
13 | items: IYamlItem[];
|
14 | /**
|
15 | * References to other items.
|
16 | *
|
17 | * NOTE: Corresponds to `ExceptionInfo.References` in DocFX.
|
18 | */
|
19 | references?: IYamlReference[];
|
20 | /**
|
21 | * NOTE: Corresponds to `ExceptionInfo.ShouldSkipMarkup` in DocFX.
|
22 | */
|
23 | shouldSkipMarkup?: boolean;
|
24 | }
|
25 | /**
|
26 | * Part of the IYamlApiFile structure. Represents basic API elements such as
|
27 | * classes, interfaces, members, etc.
|
28 | *
|
29 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.ItemViewModel` in DocFX.
|
30 | */
|
31 | export interface IYamlItem {
|
32 | /**
|
33 | * The Unique Identifier (UID) for this item.
|
34 | *
|
35 | * NOTE: Corresponds to `ItemViewModel.Uid` in DocFX.
|
36 | */
|
37 | uid: string;
|
38 | /**
|
39 | * A Roslyn comment ID (unused).
|
40 | *
|
41 | * NOTE: Corresponds to `ItemViewModel.CommentId` in DocFX.
|
42 | */
|
43 | commentId?: string;
|
44 | /**
|
45 | * The ID for this item.
|
46 | *
|
47 | * NOTE: Corresponds to `ItemViewModel.Id` in DocFX.
|
48 | */
|
49 | id?: string;
|
50 | /**
|
51 | * The Unique Identifier (UID) of the parent item. This value can vary by development language
|
52 | * by setting the relevant `parent.${lang}` property.
|
53 | *
|
54 | * NOTE: Corresponds to `ItemViewModel.Parent` in DocFX.
|
55 | * NOTE: Corresponds to `ItemViewModel.ParentInDevLangs` in DocFX when `parent.${lang}` is used.
|
56 | */
|
57 | parent?: string;
|
58 | 'parent.typeScript'?: string;
|
59 | /**
|
60 | * The Unique Identifiers (UID) of the children of this item. This value can vary by development language
|
61 | * by setting the relevant `children.${lang}` property.
|
62 | *
|
63 | * NOTE: Corresponds to `ItemViewModel.Children` in DocFX.
|
64 | * NOTE: Corresponds to `ItemViewModel.ChildrenInDevLangs` in DocFX when `children.${lang}` is used.
|
65 | */
|
66 | children?: string[];
|
67 | 'children.typeScript'?: string[];
|
68 | /**
|
69 | * Item's link URL. An item can only have a single link in cross references, so varying `href` by development
|
70 | * languages is not supported.
|
71 | *
|
72 | * NOTE: Corresponds to `ItemViewModel.Href` in DocFX.
|
73 | */
|
74 | href?: string;
|
75 | /**
|
76 | * The development languages supported by this item.
|
77 | *
|
78 | * NOTE: Corresponds to `ItemViewModel.SupportedLanguages` in DocFX.
|
79 | */
|
80 | langs?: YamlDevLangs[];
|
81 | /**
|
82 | * The local name of this item. This name should generally not be namespace qualified or include
|
83 | * parent type information. This value can vary by development language by setting the relevant
|
84 | * `name.${lang}` property.
|
85 | *
|
86 | * NOTE: Corresponds to `ItemViewModel.Name` in DocFX.
|
87 | * NOTE: Corresponds to `ItemViewModel.Names` in DocFX when `name.${lang}` is used.
|
88 | */
|
89 | name?: string;
|
90 | 'name.typeScript'?: string;
|
91 | /**
|
92 | * The name of this item including its parent type, if it has one. This name should generally not be namespace
|
93 | * qualified. This value can vary by development language by setting the relevant `nameWithType.${lang}` property.
|
94 | *
|
95 | * NOTE: Corresponds to `ItemViewModel.NameWithType` in DocFX.
|
96 | * NOTE: Corresponds to `ItemViewModel.NamesWithType` in DocFX when `nameWithType.${lang}` is used.
|
97 | */
|
98 | nameWithType?: string;
|
99 | 'nameWithType.typeScript'?: string;
|
100 | /**
|
101 | * The namespace-qualified name of this item including its parent type. This value can vary by development language
|
102 | * by setting the relevant `fullName.${lang}` property.
|
103 | *
|
104 | * NOTE: Corresponds to `ItemViewModel.FullName` in DocFX.
|
105 | * NOTE: Corresponds to `ItemViewModel.FullNames` in DocFX when `fullName.${lang}` is used.
|
106 | */
|
107 | fullName?: string;
|
108 | 'fullName.typeScript'?: string;
|
109 | /**
|
110 | * The type of source element this item represents. This value cannot vary by development language.
|
111 | *
|
112 | * NOTE: Corresponds to `ItemViewModel.Type` in DocFX.
|
113 | */
|
114 | type: YamlTypeId;
|
115 | /**
|
116 | * The location of the item's source. This value can vary by development language by setting the relevant
|
117 | * `source.${lang}` property.
|
118 | *
|
119 | * NOTE: Corresponds to `ItemViewModel.Source` in DocFX.
|
120 | * NOTE: Corresponds to `ItemViewModel.SourceInDevLangs` in DocFX when `source.${lang}` is used.
|
121 | */
|
122 | source?: IYamlSource;
|
123 | 'source.typeScript'?: IYamlSource;
|
124 | /**
|
125 | * The location of the item's documentation overrides. This value cannot vary by development language.
|
126 | *
|
127 | * NOTE: Corresponds to `ItemViewModel.Documentation` in DocFX.
|
128 | */
|
129 | documentation?: IYamlSource;
|
130 | /**
|
131 | * The names of managed assemblies that contain this item. This value can vary by development language by setting
|
132 | * the relevant `assemblies.${lang}` property.
|
133 | *
|
134 | * NOTE: Corresponds to `ItemViewModel.AssemblyNameList` in DocFX.
|
135 | * NOTE: Corresponds to `ItemViewModel.AssemblyNameListInDevLangs` in DocFX when `assemblies.${lang}` is used.
|
136 | */
|
137 | assemblies?: string[];
|
138 | 'assemblies.typeScript'?: string[];
|
139 | /**
|
140 | * The Unique Identifier (UID) of the namespace that contains this item. This value can vary by development language
|
141 | * by setting the relevant `namespace.${lang}` property.
|
142 | *
|
143 | * NOTE: Corresponds to `ItemViewModel.NamespaceName` in DocFX.
|
144 | * NOTE: Corresponds to `ItemViewModel.NamespaceNameInDevLangs` in DocFX.
|
145 | */
|
146 | namespace?: string;
|
147 | 'namespace.typeScript'?: string;
|
148 | /**
|
149 | * The summary for the item. This value cannot vary by development language.
|
150 | * Markdown is permitted.
|
151 | *
|
152 | * NOTE: Corresponds to `ItemViewModel.Summary` in DocFX.
|
153 | */
|
154 | summary?: string;
|
155 | /**
|
156 | * The remarks for the item. This value cannot vary by development language.
|
157 | * Markdown is permitted.
|
158 | *
|
159 | * NOTE: Corresponds to `ItemViewModel.Remarks` in DocFX.
|
160 | */
|
161 | remarks?: string;
|
162 | /**
|
163 | * The examples for the item. This value cannot vary by development language.
|
164 | * Markdown is permitted.
|
165 | *
|
166 | * NOTE: Corresponds to `ItemViewModel.Examples` in DocFX.
|
167 | */
|
168 | example?: string[];
|
169 | /**
|
170 | * The syntax for this item. This value itself cannot vary by development language, but
|
171 | * instead contains properties that may vary by development language.
|
172 | *
|
173 | * NOTE: Corresponds to `ItemViewModel.Syntax` in DocFX.
|
174 | */
|
175 | syntax?: IYamlSyntax;
|
176 | /**
|
177 | * The Unique Identifier (UID) of the member this item overrides. This value can vary by development language
|
178 | * by setting the relevant `overridden.${lang}` property.
|
179 | *
|
180 | * NOTE: Corresponds to `ItemViewModel.Overridden` in DocFX.
|
181 | * NOTE: Corresponds to `ItemViewModel.OverriddenInDevLangs` in DocFX when `overriden.${lang}` is used.
|
182 | */
|
183 | overridden?: string;
|
184 | 'overridden.typeScript'?: string;
|
185 | /**
|
186 | * The Unique Identifier (UID) of the member this item overloads. This value can vary by development language
|
187 | * by setting the relevant `overload.${lang}` property.
|
188 | *
|
189 | * NOTE: Corresponds to `ItemViewModel.Overload` in DocFX.
|
190 | * NOTE: Corresponds to `ItemViewModel.OverloadInDevLangs` in DocFX when `overload.${lang}` is used.
|
191 | */
|
192 | overload?: string;
|
193 | 'overload.typeScript'?: string;
|
194 | /**
|
195 | * The exceptions thrown by this item. This value can vary by development language by setting the relevant
|
196 | * `exceptions.${lang}` property.
|
197 | *
|
198 | * NOTE: Corresponds to `ItemViewModel.Exceptions` in DocFX.
|
199 | * NOTE: Corresponds to `ItemViewModel.ExceptionsInDevLangs` in DocFX when `exceptions.${lang}` is used.
|
200 | */
|
201 | exceptions?: IYamlException[];
|
202 | 'exceptions.typeScript'?: IYamlException[];
|
203 | /**
|
204 | * Links to additional content related to this item.
|
205 | *
|
206 | * NOTE: Corresponds to `ItemViewModel.SeeAlsos` in DocFX.
|
207 | */
|
208 | seealso?: IYamlLink[];
|
209 | /**
|
210 | * Additional information about other content related to this item.
|
211 | * Markdown is permitted.
|
212 | *
|
213 | * NOTE: Corresponds to `ItemViewModel.SeeAlsoContent` in DocFX.
|
214 | */
|
215 | seealsoContent?: string;
|
216 | /**
|
217 | * Links to additional content related to this item.
|
218 | *
|
219 | * NOTE: Corresponds to `ItemViewModel.Sees` in DocFX.
|
220 | */
|
221 | see?: IYamlLink[];
|
222 | /**
|
223 | * The inheritance tree for this item. Multiple inheritance is permitted for languages like Python.
|
224 | *
|
225 | * NOTE: Corresponds to `ItemViewModel.Inheritance` in DocFX.
|
226 | * NOTE: Corresponds to `ItemViewModel.InheritanceInDevLangs` in DocFX when `inheritance.${lang}` is used.
|
227 | */
|
228 | inheritance?: IYamlInheritanceTree[];
|
229 | 'inheritance.typeScript'?: IYamlInheritanceTree[];
|
230 | /**
|
231 | * NOTE: Corresponds to `ItemViewModel.DerivedClassses` in DocFX.
|
232 | * NOTE: Corresponds to `ItemViewModel.DerivedClasssesInDevLangs` in DocFX when `derivedClasses.${lang}` is used.
|
233 | */
|
234 | derivedClasses?: string[];
|
235 | 'derivedClasses.typeScript'?: string[];
|
236 | /**
|
237 | * NOTE: Corresponds to `ItemViewModel.Implements` in DocFX.
|
238 | * NOTE: Corresponds to `ItemViewModel.ImplementsInDevLangs` in DocFX when `implements.${lang}` is used.
|
239 | */
|
240 | implements?: string[];
|
241 | 'implements.typeScript'?: string[];
|
242 | /**
|
243 | * NOTE: Corresponds to `ItemViewModel.InheritedMembers` in DocFX.
|
244 | * NOTE: Corresponds to `ItemViewModel.InheritedMembersInDevLangs` in DocFX when `inheritedMembers.${lang}` is used.
|
245 | */
|
246 | inheritedMembers?: string[];
|
247 | 'inheritedMembers.typeScript'?: string[];
|
248 | /**
|
249 | * NOTE: Corresponds to `ItemViewModel.ExtensionMethods` in DocFX.
|
250 | * NOTE: Corresponds to `ItemViewModel.ExtensionMethodsInDevLangs` in DocFX when `extensionMethods.${lang}` is used.
|
251 | */
|
252 | extensionMethods?: string[];
|
253 | 'extensionMethods.typeScript'?: string[];
|
254 | /**
|
255 | * NOTE: Corresponds to `ItemViewModel.Conceptual` in DocFX.
|
256 | */
|
257 | conceptual?: string;
|
258 | /**
|
259 | * NOTE: Corresponds to `ItemViewModel.Platform` in DocFX.
|
260 | * NOTE: Corresponds to `ItemViewModel.PlatformInDevLangs` in DocFX when `platform.${lang}` is used.
|
261 | */
|
262 | platform?: string[];
|
263 | 'platform.typeScript'?: string[];
|
264 | /**
|
265 | * NOTE: This is an extension and corresponds to `ItemViewModel.Metadata` in DocFX.
|
266 | */
|
267 | deprecated?: IYamlDeprecatedNotice;
|
268 | /**
|
269 | * NOTE: This is an extension and corresponds to `ItemViewModel.Metadata` in DocFX.
|
270 | */
|
271 | extends?: string[];
|
272 | /**
|
273 | * NOTE: This is an extension and corresponds to `ItemViewModel.Metadata` in DocFX.
|
274 | */
|
275 | isPreview?: boolean;
|
276 | /**
|
277 | * NOTE: In TypeScript, enum members can be strings or integers.
|
278 | * If it is an integer, then enumMember.value will be a string representation of the integer.
|
279 | * If it is a string, then enumMember.value will include the quotation marks.
|
280 | *
|
281 | * NOTE: This is an extension and corresponds to `ItemViewModel.Metadata` in DocFX.
|
282 | */
|
283 | numericValue?: string;
|
284 | /**
|
285 | * NOTE: This is an extension and corresponds to `ItemViewModel.Metadata` in DocFX.
|
286 | */
|
287 | package?: string;
|
288 | }
|
289 | /**
|
290 | * Part of the IYamlApiFile structure. Represents the type of an IYamlItem.
|
291 | */
|
292 | export declare type YamlTypeId = 'class' | 'constructor' | 'enum' | 'field' | 'function' | 'interface' | 'method' | 'package' | 'property' | 'event' | 'typealias' | 'variable' | 'namespace';
|
293 | /**
|
294 | * Development languages supported by the Universal Reference file format, as defined by typescript.schema.json.
|
295 | */
|
296 | export declare type YamlDevLangs = 'typeScript';
|
297 | /**
|
298 | * Part of the IYamlApiFile structure. Documents the source file where an IYamlItem is defined.
|
299 | *
|
300 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.Common.SourceDetail` in DocFX.
|
301 | */
|
302 | export interface IYamlSource {
|
303 | /**
|
304 | * Information about the Git repository where this source can be found.
|
305 | *
|
306 | * NOTE: Corresponds to `SourceDetail.Remote` in DocFX.
|
307 | */
|
308 | remote?: IYamlRemote;
|
309 | /**
|
310 | * The base path for the source for this item.
|
311 | *
|
312 | * NOTE: Corresponds to `SourceDetail.BasePath` in DocFX.
|
313 | */
|
314 | basePath?: string;
|
315 | /**
|
316 | * The name of the item.
|
317 | *
|
318 | * NOTE: Corresponds to `SourceDetail.Name` in DocFX.
|
319 | */
|
320 | id?: string;
|
321 | /**
|
322 | * A link to the source for this item.
|
323 | *
|
324 | * NOTE: Corresponds to `SourceDetail.Href` in DocFX.
|
325 | */
|
326 | href?: string;
|
327 | /**
|
328 | * The path to the source for this item. This path will be made relative to `basePath` in the documentation.
|
329 | *
|
330 | * NOTE: Corresponds to `SourceDetail.Path` in DocFX.
|
331 | */
|
332 | path?: string;
|
333 | /**
|
334 | * The starting line of the source for this item.
|
335 | *
|
336 | * NOTE: Corresponds to `SourceDetail.StartLine` in DocFX.
|
337 | */
|
338 | startLine?: number;
|
339 | /**
|
340 | * The ending line of the source for this item.
|
341 | *
|
342 | * NOTE: Corresponds to `SourceDetail.EndLine` in DocFX.
|
343 | */
|
344 | endLine?: number;
|
345 | /**
|
346 | * The content of the source for this item.
|
347 | *
|
348 | * NOTE: Corresponds to `SourceDetail.Content` in DocFX.
|
349 | */
|
350 | content?: string;
|
351 | /**
|
352 | * Indicates whether the path to the source is not locally available.
|
353 | *
|
354 | * NOTE: Corresponds to `SourceDetail.IsExternal` in DocFX.
|
355 | */
|
356 | isExternal?: boolean;
|
357 | }
|
358 | /**
|
359 | * Part of the IYamlApiFile structure. Indicates the open source Git repository
|
360 | * where an IYamlItem is defined.
|
361 | *
|
362 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.Common.GitDetail` in DocFX.
|
363 | */
|
364 | export interface IYamlRemote {
|
365 | /**
|
366 | * The relative path of the current item to the Git repository root directory.
|
367 | *
|
368 | * NOTE: Corresponds to `GitDetail.RelativePath` in DocFX.
|
369 | */
|
370 | path?: string;
|
371 | /**
|
372 | * The Git branch in which this item can be found.
|
373 | *
|
374 | * NOTE: Corresponds to `GitDetail.RemoteBranch` in DocFX.
|
375 | */
|
376 | branch?: string;
|
377 | /**
|
378 | * The Git repository in which this item can be found.
|
379 | *
|
380 | * NOTE: Corresponds to `GitDetail.RemoteRepositoryUrl` in DocFX.
|
381 | */
|
382 | repo?: string;
|
383 | }
|
384 | /**
|
385 | * Part of the IYamlApiFile structure. Documents the type signature for an IYamlItem.
|
386 | *
|
387 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.SyntaxDetailViewModel` in DocFX.
|
388 | */
|
389 | export interface IYamlSyntax {
|
390 | /**
|
391 | * The content for the syntax of this item.
|
392 | *
|
393 | * NOTE: Corresponds to `SyntaxDetailViewModel.Content` in DocFX.
|
394 | * NOTE: Corresponds to `SyntaxDetailViewModel.Contents` in DocFX when `content.${lang}` is used.
|
395 | */
|
396 | content?: string;
|
397 | 'content.typeScript'?: string;
|
398 | /**
|
399 | * The parameters for this item.
|
400 | *
|
401 | * NOTE: Corresponds to `SyntaxDetailViewModel.Parameters` in DocFX.
|
402 | */
|
403 | parameters?: IYamlParameter[];
|
404 | /**
|
405 | * The type parameters for this item.
|
406 | *
|
407 | * NOTE: Corresponds to `SyntaxDetailViewModel.TypeParameters` in DocFX.
|
408 | */
|
409 | typeParameters?: IYamlParameter[];
|
410 | /**
|
411 | * The return type for this item.
|
412 | *
|
413 | * NOTE: Corresponds to `SyntaxDetailViewModel.Return` in DocFX.
|
414 | * NOTE: Corresponds to `SyntaxDetailViewModel.ReturnInDevLangs` in DocFX when `return.${lang}` is used.
|
415 | */
|
416 | return?: IYamlReturn;
|
417 | 'return.typeScript'?: IYamlReturn;
|
418 | }
|
419 | /**
|
420 | * Part of the IYamlApiFile structure. Represents a method or function parameter.
|
421 | *
|
422 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.ApiParameter` in DocFX.
|
423 | */
|
424 | export interface IYamlParameter {
|
425 | /**
|
426 | * The name of the parameter.
|
427 | *
|
428 | * NOTE: Corresponds to `ApiParameter.Name` in DocFX.
|
429 | */
|
430 | id?: string;
|
431 | /**
|
432 | * The Unique Identifiers (UIDs) of the types for this parameter.
|
433 | *
|
434 | * NOTE: Corresponds to `ApiParameter.Type` in DocFX.
|
435 | */
|
436 | type?: string[];
|
437 | /**
|
438 | * The description for this parameter.
|
439 | * Markdown is permitted.
|
440 | *
|
441 | * NOTE: Corresponds to `ApiParameter.Description` in DocFX.
|
442 | */
|
443 | description?: string;
|
444 | /**
|
445 | * Indicates whether the parameter is optional.
|
446 | *
|
447 | * NOTE: Corresponds to `ApiParameter.Optional` in DocFX.
|
448 | */
|
449 | optional?: boolean;
|
450 | /**
|
451 | * The default value for the parameter.
|
452 | *
|
453 | * NOTE: Corresponds to `ApiParameter.DefaultValue` in DocFX.
|
454 | */
|
455 | defaultValue?: string;
|
456 | }
|
457 | /**
|
458 | * Part of the IYamlApiFile structure. Documents the return value of a function
|
459 | * or method.
|
460 | *
|
461 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.ApiParameter` in DocFX.
|
462 | */
|
463 | export interface IYamlReturn {
|
464 | /**
|
465 | * The Unique Identifiers (UIDs) of the types for this parameter.
|
466 | *
|
467 | * NOTE: Corresponds to `ApiParameter.Type` in DocFX.
|
468 | */
|
469 | type?: string[];
|
470 | /**
|
471 | * The description for this parameter.
|
472 | * Markdown is permitted.
|
473 | *
|
474 | * NOTE: Corresponds to `ApiParameter.Description` in DocFX.
|
475 | */
|
476 | description?: string;
|
477 | }
|
478 | /**
|
479 | * Part of the IYamlApiFile structure. Used to document exceptions that can be thrown
|
480 | * by a method, property, function, or constructor.
|
481 | *
|
482 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.ExceptionInfo` in DocFX.
|
483 | */
|
484 | export interface IYamlException {
|
485 | /**
|
486 | * The Unique Identifier (UID) of the type for this exception.
|
487 | *
|
488 | * NOTE: Corresponds to `ExceptionInfo.Type` in DocFX.
|
489 | */
|
490 | type?: string;
|
491 | /**
|
492 | * The description for this exception.
|
493 | *
|
494 | * NOTE: Corresponds to `ExceptionInfo.Description` in DocFX.
|
495 | */
|
496 | description?: string;
|
497 | }
|
498 | /**
|
499 | * Part of the IYamlApiFile structure. Used to indicate links to external content or other documentation.
|
500 | *
|
501 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.LinkInfo` in DocFX.
|
502 | */
|
503 | export interface IYamlLink {
|
504 | /**
|
505 | * The type of link.
|
506 | *
|
507 | * The value `"CRef"` indicates that `linkId` is a Unique Identifier (UID) reference to
|
508 | * another documentation entry.
|
509 | *
|
510 | * The value `"HRef"` indicates that `linkId` is a link to external documentation.
|
511 | * NOTE: Corresponds to `LinkInfo.LinkType` in DocFX.
|
512 | */
|
513 | linkType: 'CRef' | 'HRef';
|
514 | /**
|
515 | * When `linkType` is `"CRef"`, this is a Unique Identifier (UID) reference to another documentation entry.
|
516 | *
|
517 | * When `linkType` is `"HRef"`, this is a link to external documentation.
|
518 | *
|
519 | * NOTE: Corresponds to `LinkInfo.LinkId` in DocFX.
|
520 | */
|
521 | linkId: string;
|
522 | /**
|
523 | * A Roslyn comment ID for this link.
|
524 | *
|
525 | * NOTE: Corresponds to `LinkInfo.CommentId` in DocFX.
|
526 | */
|
527 | commentId?: string;
|
528 | /**
|
529 | * Alternate text to display for thie link.
|
530 | *
|
531 | * NOTE: Corresponds to `LinkInfo.AltText` in DocFX.
|
532 | */
|
533 | altText?: string;
|
534 | }
|
535 | /**
|
536 | * Part of the IYamlApiFile structure. Represents the inheritance hierarchy of an item.
|
537 | *
|
538 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.UniversalReference.InheritanceTree` in DocFX.
|
539 | */
|
540 | export interface IYamlInheritanceTree {
|
541 | /**
|
542 | * The Unique Identifier (UID) of the type from which an item or type inherits.
|
543 | *
|
544 | * NOTE: Corresponds to `InheritanceTree.Type` in DocFX.
|
545 | */
|
546 | type: string;
|
547 | /**
|
548 | * The inheritance tree for the specified type. Multiple inheritance is permitted for languages like Python.
|
549 | *
|
550 | * NOTE: Corresponds to `InheritanceTree.Inheritance` in DocFX.
|
551 | */
|
552 | inheritance?: IYamlInheritanceTree[];
|
553 | }
|
554 | /**
|
555 | * Part of the IYamlApiFile structure. Represents a reference to an item that is
|
556 | * declared in a separate YAML file.
|
557 | *
|
558 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.Common.ReferenceViewModel` in DocFX.
|
559 | */
|
560 | export interface IYamlReference {
|
561 | /**
|
562 | * NOTE: Corresponds to `ReferenceViewModel.Uid` in DocFX.
|
563 | */
|
564 | uid?: string;
|
565 | /**
|
566 | * NOTE: Corresponds to `ReferenceViewModel.CommentId` in DocFX.
|
567 | */
|
568 | commentId?: string;
|
569 | /**
|
570 | * NOTE: Corresponds to `ReferenceViewModel.Parent` in DocFX.
|
571 | */
|
572 | parent?: string;
|
573 | /**
|
574 | * NOTE: Corresponds to `ReferenceViewModel.Definition` in DocFX.
|
575 | */
|
576 | definition?: string;
|
577 | /**
|
578 | * NOTE: Corresponds to `ReferenceViewModel.IsExternal` in DocFX.
|
579 | */
|
580 | isExternal?: boolean;
|
581 | /**
|
582 | * NOTE: Corresponds to `ReferenceViewModel.Href` in DocFX.
|
583 | */
|
584 | href?: string;
|
585 | /**
|
586 | * NOTE: Corresponds to `ReferenceViewModel.Name` in DocFX.
|
587 | * NOTE: Corresponds to `ReferenceViewModel.NameInDevLangs` in DocFX when `name.${lang}` is used.
|
588 | */
|
589 | name?: string;
|
590 | 'name.typeScript'?: string;
|
591 | /**
|
592 | * NOTE: Corresponds to `ReferenceViewModel.NameWithType` in DocFX.
|
593 | * NOTE: Corresponds to `ReferenceViewModel.NameWithTypeInDevLangs` in DocFX when `nameWithType.${lang}` is used.
|
594 | */
|
595 | nameWithType?: string;
|
596 | 'nameWithType.typeScript'?: string;
|
597 | /**
|
598 | * NOTE: Corresponds to `ReferenceViewModel.FullName` in DocFX.
|
599 | * NOTE: Corresponds to `ReferenceViewModel.FullNameInDevLangs` in DocFX when `fullName.${lang}` is used.
|
600 | */
|
601 | fullName?: string;
|
602 | 'fullName.typeScript'?: string;
|
603 | /**
|
604 | * NOTE: Corresponds to `ReferenceViewModel.Spec` in DocFX.
|
605 | */
|
606 | 'spec.typeScript'?: IYamlReferenceSpec[];
|
607 | }
|
608 | /**
|
609 | * Part of the IYamlApiFile structure. Represents a text specification for a reference.
|
610 | *
|
611 | * NOTE: Corresponds to `Microsoft.DocAsCode.DataContracts.Common.SpecViewModel` in DocFX.
|
612 | */
|
613 | export interface IYamlReferenceSpec {
|
614 | /**
|
615 | * NOTE: Corresponds to `SpecViewModel.Uid` in DocFX.
|
616 | */
|
617 | uid?: string;
|
618 | /**
|
619 | * NOTE: Corresponds to `SpecViewModel.Name` in DocFX.
|
620 | */
|
621 | name?: string;
|
622 | /**
|
623 | * NOTE: Corresponds to `SpecViewModel.NameWithType` in DocFX.
|
624 | */
|
625 | nameWithType?: string;
|
626 | /**
|
627 | * NOTE: Corresponds to `SpecViewModel.FullName` in DocFX.
|
628 | */
|
629 | fullName?: string;
|
630 | /**
|
631 | * NOTE: Corresponds to `SpecViewModel.IsExternal` in DocFX.
|
632 | */
|
633 | isExternal?: boolean;
|
634 | /**
|
635 | * NOTE: Corresponds to `SpecViewModel.Href` in DocFX.
|
636 | */
|
637 | href?: string;
|
638 | }
|
639 | /**
|
640 | * NOTE: This is an extension to the Universal Reference format and does not correspond to
|
641 | * a known type in DocFX.
|
642 | */
|
643 | export interface IYamlDeprecatedNotice {
|
644 | content: string;
|
645 | }
|
646 | //# sourceMappingURL=IYamlApiFile.d.ts.map |
\ | No newline at end of file |