Add @inheritdoc #2943
Add @inheritdoc #2943
Conversation
wnvko
added
📖 documentation
✅ status: verified
| @@ -56,17 +92,29 @@ export class IgxBaseTransactionService<T extends Transaction, S extends State> i | |||
| return state.value; | |||
| } | |||
|
|
|||
| /** | |||
| * @inheritdoc | |||
| */ | |||
| commit(data: any): void { } | |||
There was a problem hiding this comment.
the signatures between the interface and the class are not the same we have commit(data: any): void and commit(data: any[]): void. Parameters does not match which leads to unsuccessful comment inheritance.
| @@ -31,6 +31,9 @@ export class AutoPositionStrategy extends ConnectedPositioningStrategy implement | |||
|
|
|||
|
|
|||
| // The position method should return a <div> container that will host the component | |||
| /** | |||
| * @inheritdoc | |||
| */ | |||
| position(contentElement: HTMLElement, size: { width: number, height: number }, document?: Document, initialCall?: boolean): void { | |||
There was a problem hiding this comment.
Signatures between the interface and the class are not the same. Parameters does not match which leads to unsuccessful comment inheritance.
| /** | ||
| * @inheritdoc | ||
| */ | ||
| position(contentElement: HTMLElement, size: { width: number, height: number }, document?: Document, initialCall?: boolean): void { |
There was a problem hiding this comment.
Signatures between the interface and the class are not the same. Parameters does not match which leads to unsuccessful comment inheritance.
| @@ -17,6 +17,9 @@ export class GlobalPositionStrategy implements IPositionStrategy { | |||
| this.settings = Object.assign({}, this._defaultSettings, settings); | |||
| } | |||
|
|
|||
| /** | |||
| * @inheritdoc | |||
| */ | |||
| position(contentElement: HTMLElement, size?: { width: number, height: number}, document?: Document, initialCall?: boolean): void { | |||
There was a problem hiding this comment.
Signatures between the interface and the class are not the same. Parameters does not match which leads to unsuccessful comment inheritance.
…om/IgniteUI/igniteui-angular into mvenkov/add-inheritdoc-to-comments
…om/IgniteUI/igniteui-angular into mvenkov/add-inheritdoc-to-comments
TypeDocs may take dev comments only from interfaces when @inheritdoc is added. However, scroll strategies need to have constructor. This is why we add ScrollStrategy abstract class. It is implementing IScrollStrategy, and then all implementations extends the new abstract class
…om/IgniteUI/igniteui-angular into mvenkov/add-inheritdoc-to-comments
Aleksandyr
added
❌ status: awaiting-test
| @@ -17,5 +20,5 @@ export interface IPositionStrategy { | |||
| * settings.positionStrategy.position(content, size, document, true); | |||
| * ``` | |||
| */ | |||
| position(contentElement: HTMLElement, size?: {}, document?: Document, initialCall?: boolean): void; | |||
| position(contentElement: HTMLElement, size?: { width: number, height: number }, document?: Document, initialCall?: boolean): void; | |||
There was a problem hiding this comment.
This won't work because the size parameter is a object and when the comparison between the parameters came the objects would have different references which respectively means that the parameters are not equal.
There was a problem hiding this comment.
Fixed. Now we have Size interface and position method accepts Size parameter.
Aleksandyr
added
🛠️ status: in-development
wnvko
added
❌ status: awaiting-test
bazal4o
added
💥 status: in-test
bazal4o
added
✅ status: verified
Add @inheritdoc to public fields in classes which implementing interfaces. This allows comments from interfaces to show in classes in TypeDoc API documentation.