Fix docs gen, add docs comments

Author: szuperaz

package.json

@@ -38,7 +38,7 @@
     "generate-docs": "npm run typedoc:services && npm run typedoc:components && npm run copy-docs:v6",
     "typedoc:services": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-reference-excluder --cleanOutputDir true --excludeConstructors true --hideBreadcrumbs true --hideInPageTOC true --excludePrivate true --out temp-service-docs --exclude '!**/*service.ts' --excludeNotDocumented --tsconfig projects/stream-chat-angular/tsconfig.lib.json projects/stream-chat-angular/src/public-api.ts",
     "typedoc:components": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-plugin-reference-excluder --cleanOutputDir true --excludeConstructors true --sort source-order --hideBreadcrumbs true --hideInPageTOC true --excludePrivate true --excludeNotDocumented --out temp-component-docs --exclude '!**/*component.ts' --tsconfig projects/stream-chat-angular/tsconfig.lib.json projects/stream-chat-angular/src/public-api.ts",
-    "copy-docs:v6": "ts-node copy-generated-service-docs.ts ../docs/data/docs/chat-sdk/angular/06-services & (ts-node remove-generated-component-docs-content ../docs/data/docs/chat-sdk/angular/05-components && ts-node copy-generated-component-docs.ts ../docs/data/docs/chat-sdk/angular/05-components)"
+    "copy-docs:v6": "ts-node copy-generated-service-docs.ts ../docs/data/docs/chat-sdk/angular/v6-latest/06-services & (ts-node remove-generated-component-docs-content ../docs/data/docs/chat-sdk/angular/v6-latest/05-components && ts-node copy-generated-component-docs.ts ../docs/data/docs/chat-sdk/angular/v6-latest/05-components)"
   },
   "lint-staged": {
     "**/*": [

projects/stream-chat-angular/src/lib/polls/base-poll.component.ts

@@ -16,7 +16,7 @@ import { CustomTemplatesService } from '../custom-templates.service';
 import { NotificationService } from '../notification.service';
 
 /**
- *
+ * @internal
  */
 @Component({
   selector: 'stream-base-poll',
@@ -26,7 +26,13 @@ import { NotificationService } from '../notification.service';
 export abstract class BasePollComponent
   implements OnChanges, AfterViewInit, OnDestroy
 {
+  /**
+   * The poll id to display
+   */
   @Input() pollId: string | undefined;
+  /**
+   * The message id the poll is attached to
+   */
   @Input() messageId: string | undefined;
   canVote = false;
   canQueryVotes = false;

projects/stream-chat-angular/src/lib/polls/poll-actions/add-option/add-option.component.ts

@@ -20,6 +20,9 @@ import { createUniqueValidator } from '../../unique.validator';
 })
 export class AddOptionComponent extends BasePollComponent {
   @HostBinding('class') class = 'str-chat__dialog';
+  /**
+   * The callback to close the modal the component is displayed in
+   */
   @Input() closeModal: () => void = () => {};
   formGroup = new FormGroup({
     text: new FormControl('', [

projects/stream-chat-angular/src/lib/polls/poll-actions/poll-actions.component.ts

@@ -33,7 +33,13 @@ type Action =
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class PollActionsComponent extends BasePollComponent {
+  /**
+   * If there are more options than this number, the "See all options" button will be displayed
+   */
   @Input() maxOptionsDisplayed: number | undefined = 10;
+  /**
+   * The maximum number of options allowed for the poll, this is defined by Stream API
+   */
   @Input() maxPollOptions = 100;
   name = '';
   options: PollOption[] = [];

projects/stream-chat-angular/src/lib/polls/poll-actions/poll-answers-list/poll-answers-list.component.ts

@@ -24,6 +24,9 @@ export class PollAnswersListComponent
   implements OnChanges
 {
   @HostBinding('class') class = 'str-chat__modal__poll-answer-list';
+  /**
+   * The even that's emitted when the update/add comment button is clicked
+   */
   @Output() upsertOwnAnswer = new EventEmitter<void>();
   isLoading = false;
   next?: string | undefined;

projects/stream-chat-angular/src/lib/polls/poll-actions/poll-results/poll-vote-results-list/poll-vote-results-list.component.ts

@@ -21,6 +21,9 @@ export class PollVoteResultsListComponent
   extends BasePollComponent
   implements OnChanges
 {
+  /**
+   * The poll option to display the votes for
+   */
   @Input() option: PollOption | undefined;
   isWinner = false;
   voteCount = 0;

projects/stream-chat-angular/src/lib/polls/poll-actions/poll-results/poll-vote/poll-vote.component.ts

@@ -13,6 +13,9 @@ import { DateParserService } from '../../../../date-parser.service';
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class PollVoteComponent {
+  /**
+   * The poll vote or answer to display
+   */
   @Input() vote: PollVote | PollAnswer | undefined;
   anonymousTranslation = 'Anonymous';
 

projects/stream-chat-angular/src/lib/polls/poll-actions/upsert-answer/upsert-answer.component.ts

@@ -24,7 +24,13 @@ export class UpsertAnswerComponent
   implements OnChanges
 {
   @HostBinding('class') class = 'str-chat__dialog';
+  /**
+   * The poll comment to edit, when in edit mode
+   */
   @Input() answer: PollAnswer | undefined;
+  /**
+   * The callback to close the modal the component is displayed in
+   */
   @Input() closeModal: () => void = () => {};
   formGroup = new FormGroup({
     comment: new FormControl('', [Validators.required]),

projects/stream-chat-angular/src/lib/polls/poll-composer/poll-composer.component.ts

@@ -22,7 +22,13 @@ import { atLeastOneOption, maximumNumberOfVotes } from './validators';
   styles: [],
 })
 export class PollComposerComponent {
+  /**
+   * Emitted when a poll is created, the poll id is emitted
+   */
   @Output() pollCompose = new EventEmitter<string>();
+  /**
+   * Emitted when the poll composing is cancelled
+   */
   @Output() cancel = new EventEmitter<void>();
   formGroup = new FormGroup({
     name: new FormControl('', [Validators.required]),

projects/stream-chat-angular/src/lib/polls/poll-options-list/poll-options-list.component.ts

@@ -12,6 +12,9 @@ import { Poll, PollOption } from 'stream-chat';
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class PollOptionsListComponent extends BasePollComponent {
+  /**
+   * How many options should be displayed. If there are more options than this number, use the poll actions to display all options
+   */
   @Input() maxOptionsDisplayed: number | undefined = 10;
   options: PollOption[] = [];