Skip to content

Commit 6a861e9

Browse files
jhonyeduardojhosefmarks
authored andcommitted
build(tsconfig): altera annotateForClosureCompiler para false
Altera annotateForClosureCompiler para false, para que seja possível adicionar { } em volta do tipo do parametro/retorno no JSDoc, assim nosso portal identifica o tipo e exibe em um formato mais adequado. Pois anteriormente ocorria erro no build, informando que não era necessario informar o tipo, Porém o portal não conseguia identificar corretamente. Documentações corrigidas: - PoComboFilterInterface - PoStepperComponent - PoI18n - PoNotification
1 parent 5676932 commit 6a861e9

File tree

5 files changed

+19
-23
lines changed

5 files changed

+19
-23
lines changed

projects/ui/src/lib/components/po-field/po-combo/interfaces/po-combo-filter.interface.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ export interface PoComboFilter {
1515
* Método responsável por retornar um Observable que contém uma coleção de objetos que seguem a interface PoComboOption,
1616
* será informado por parametro o campo, de acordo com o fieldLabel, e o valor a ser pesquisado.
1717
*
18-
* @param params {any} Objeto contendo a propriedade e o valor responsável por realizar o filtro.
19-
* @param filterParams {any} Valor informado através da propriedade `p-filter-params`.
18+
* @param {any} params Objeto contendo a propriedade e o valor responsável por realizar o filtro.
19+
* @param {any} filterParams Valor informado através da propriedade `p-filter-params`.
2020
*/
2121
getFilteredData(params: any, filterParams?: any): Observable<Array<PoComboOption>>;
2222

2323
/**
2424
* Método responsável por retornar um Observable que contém apenas o objeto filtrado que seguem a interface PoComboOption,
2525
* será informado por parametro valor a ser pesquisado.
2626
*
27-
* @param value {string | number} Valor responsável por realizar a busca de um único objeto.
28-
* @param filterParams {any} Valor informado através da propriedade `p-filter-params`.
27+
* @param {string | number} value Valor responsável por realizar a busca de um único objeto.
28+
* @param {any} filterParams Valor informado através da propriedade `p-filter-params`.
2929
*/
3030
getObjectByValue(value: string | number, filterParams?: any): Observable<PoComboOption>;
3131

projects/ui/src/lib/components/po-stepper/po-stepper.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class PoStepperComponent extends PoStepperBaseComponent implements AfterC
6565
*
6666
* > Este método é valido apenas para as implementações que utilizam o componente [**po-step**](/documentation/po-step).
6767
*
68-
* @param index {number} Índice do `po-step` que se deseja ativar.
68+
* @param {number} index Índice do `po-step` que se deseja ativar.
6969
*/
7070
active(index: number): void {
7171
if (!this.usePoSteps) {

projects/ui/src/lib/services/po-i18n/po-i18n-base.service.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,7 @@ export class PoI18nBaseService {
177177
*
178178
* > Caso o idioma do navegador não seja suportado pelo PO (`pt`, `en` ou `es`), será retornado valor `pt`.
179179
*
180-
* **Retorno:**
181-
*
182-
* `string` com a sigla do idioma padrão.
180+
* @returns {string} sigla do idioma padrão.
183181
*/
184182
getLanguage(): string {
185183
return this.languageService.getLanguage();
@@ -191,9 +189,7 @@ export class PoI18nBaseService {
191189
*
192190
* A busca deste idioma é baseada no método [**getLanguage()**](/documentation/po-i18n#get-language).
193191
*
194-
* **Retorno:**
195-
*
196-
* `string` com a sigla do idioma padrão.
192+
* @returns {string} sigla do idioma padrão.
197193
*/
198194
getShortLanguage(): string {
199195
return this.languageService.getShortLanguage();
@@ -206,14 +202,14 @@ export class PoI18nBaseService {
206202
* Ao utilizar este método, o idioma ficará gravado no armazenamento local do navegador, que será utilizado pelo
207203
* serviço do `i18n` para buscar as literais no idioma padrão.
208204
*
209-
* @param language {string} Sigla do idioma.
205+
* @param {string} language Sigla do idioma.
210206
*
211207
* Esta sigla deve ser composta por duas letras representando o idioma,
212208
* podendo ser adicionado outras duas letras representando o país, por exemplo: `pt`, `pt-BR`, `pt-br`, `en` ou `en-US`.
213209
*
214210
* > Caso seja informado um valor diferente deste padrão, o mesmo será ignorado.
215211
*
216-
* @param reload {boolean} Indica se a página atual poderá ser recarregada após a alteração do idioma.
212+
* @param {boolean} reload Indica se a página atual poderá ser recarregada após a alteração do idioma.
217213
*
218214
* Este recurso pode ser útil para os usuários que utilizam o método `getLiterals()` do serviço do i18n para poder
219215
* buscar novamente as literais no novo idioma configurado.

projects/ui/src/lib/services/po-notification/po-notification-base.service.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export abstract class PoNotificationBaseService {
3636
/**
3737
* Emite uma notificação de sucesso.
3838
*
39-
* @param notification {PoNotification | string} Objeto com os dados da notificação ou somente a string com a mensagem da notificação.
39+
* @param {PoNotification | string} notification Objeto com os dados da notificação ou somente a string com a mensagem da notificação.
4040
*/
4141
public success(notification: PoNotification | string) {
4242
this.createToaster(this.buildToaster(notification, PoToasterType.Success));
@@ -45,7 +45,7 @@ export abstract class PoNotificationBaseService {
4545
/**
4646
* Emite uma notificação de atenção.
4747
*
48-
* @param notification {PoNotification | string} Objeto com os dados da notificação ou somente a string com a mensagem da notificação
48+
* @param {PoNotification | string} notification Objeto com os dados da notificação ou somente a string com a mensagem da notificação
4949
*/
5050
public warning(notification: PoNotification | string) {
5151
this.createToaster(this.buildToaster(notification, PoToasterType.Warning));
@@ -54,7 +54,7 @@ export abstract class PoNotificationBaseService {
5454
/**
5555
* Emite uma notificação de erro.
5656
*
57-
* @param notification {PoNotification | string} Objeto com os dados da notificação ou somente a string com a mensagem da notificação
57+
* @param {PoNotification | string} notification Objeto com os dados da notificação ou somente a string com a mensagem da notificação
5858
*/
5959
public error(notification: PoNotification | string) {
6060
this.createToaster(this.buildToaster(notification, PoToasterType.Error));
@@ -63,7 +63,7 @@ export abstract class PoNotificationBaseService {
6363
/**
6464
* Emite uma notificação de informação.
6565
*
66-
* @param notification {PoNotification | string} Objeto com os dados da notificação ou somente a string com a mensagem da notificação
66+
* @param {PoNotification | string} notification Objeto com os dados da notificação ou somente a string com a mensagem da notificação
6767
*/
6868
public information(notification: PoNotification | string) {
6969
this.createToaster(this.buildToaster(notification, PoToasterType.Information));
@@ -74,7 +74,7 @@ export abstract class PoNotificationBaseService {
7474
*
7575
* > Padrão 10 segundos.
7676
*
77-
* @param defaultDuration {number} Duração em milisegundos
77+
* @param {number} defaultDuration Duração em milisegundos
7878
*/
7979
public setDefaultDuration(defaultDuration: number) {
8080
this.defaultDuration = defaultDuration;
@@ -85,7 +85,7 @@ export abstract class PoNotificationBaseService {
8585
*
8686
* Cria um objeto do tipo PoToaster de acordo o tipo.
8787
*
88-
* @param notification {PoNotification | string} Objeto PoNotification com os dados da notificação
88+
* @param {PoNotification | string} notification Objeto PoNotification com os dados da notificação
8989
*/
9090
private buildToaster(notification: PoNotification | string, type: PoToasterType): PoToaster {
9191
let index = 0;
@@ -126,7 +126,7 @@ export abstract class PoNotificationBaseService {
126126
*
127127
* Método responsável por criar o po-toaster.
128128
*
129-
* @param toaster {PoToaster} Objeto contendo as informações do toaster.
129+
* @param {PoToaster} toaster Objeto contendo as informações do toaster.
130130
*/
131131
abstract createToaster(toaster: PoToaster): void;
132132

@@ -135,8 +135,8 @@ export abstract class PoNotificationBaseService {
135135
*
136136
* Método responsável por destruir o po-toaster.
137137
*
138-
* @param toaster {ComponentRef} Número da posição ou instancia do toaster a ser destruído.
139-
* @param orientation {PoToasterOrientation} Orientação do PoToaster: Top ou Bottom
138+
* @param {ComponentRef} toaster Número da posição ou instancia do toaster a ser destruído.
139+
* @param {PoToasterOrientation} orientation Orientação do PoToaster: Top ou Bottom
140140
*/
141141
abstract destroyToaster(toaster: ComponentRef<any>): void;
142142

projects/ui/tsconfig.lib.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
]
1414
},
1515
"angularCompilerOptions": {
16-
"annotateForClosureCompiler": true,
16+
"annotateForClosureCompiler": false,
1717
"skipTemplateCodegen": true,
1818
"strictMetadataEmit": true,
1919
"fullTemplateTypeCheck": true,

0 commit comments

Comments
 (0)