docs: pipe add private #INFR-10725

atinc · Dec 5, 2023 · e07b253 · e07b253
1 parent 40fc0f3
commit e07b253
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 3 deletions.
diff --git a/src/avatar/avatar.pipe.ts b/src/avatar/avatar.pipe.ts
@@ -9,6 +9,9 @@ const UNIFIED_IDEOGRAPHS_REGEX = /^[\u4e00-\u9fa5]+$/;
 
 const SET_OF_LETTERS_REGEX = /^[a-zA-Z\/ ]+$/;
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'avatarShortName',
     standalone: true
@@ -34,6 +37,9 @@ export class AvatarShortNamePipe implements PipeTransform {
     }
 }
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'avatarBgColor',
     standalone: true
@@ -61,6 +67,9 @@ export class AvatarBgColorPipe implements PipeTransform {
     }
 }
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'thyAvatarSrc',
     standalone: true

diff --git a/src/date-picker/picker.pipes.ts b/src/date-picker/picker.pipes.ts
@@ -1,10 +1,13 @@
 import { Pipe, PipeTransform } from '@angular/core';
-import { DateHelperService } from './date-helper.service';
-import { CompatibleDate, DateEntry, ThyDateRangeEntry, ThyDateGranularity } from './standard-types';
-import { getFlexibleAdvancedReadableValue, transformDateValue } from './picker.util';
 import { TinyDate } from 'ngx-tethys/util';
+import { DateHelperService } from './date-helper.service';
 import { AdvancedSelectableCell } from './inner-types';
+import { getFlexibleAdvancedReadableValue, transformDateValue } from './picker.util';
+import { CompatibleDate, DateEntry, ThyDateGranularity, ThyDateRangeEntry } from './standard-types';
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'thyDatePickerFormat',
     standalone: true
@@ -32,6 +35,9 @@ export class ThyDatePickerFormatPipe implements PipeTransform {
     }
 }
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'thyDatePickerFormatString',
     standalone: true
@@ -45,6 +51,10 @@ export class ThyDatePickerFormatStringPipe implements PipeTransform {
         return withTime ? 'yyyy-MM-dd HH:mm' : 'yyyy-MM-dd';
     }
 }
+
+/**
+ * @private
+ */
 @Pipe({
     name: 'showYearTip',
     standalone: true

diff --git a/src/nav/nav.pipe.ts b/src/nav/nav.pipe.ts
@@ -1,6 +1,9 @@
 import { Pipe, PipeTransform } from '@angular/core';
 import { DomSanitizer } from '@angular/platform-browser';
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'bypassSecurityTrustHtml',
     standalone: true

diff --git a/src/pagination/pagination.pipe.ts b/src/pagination/pagination.pipe.ts
@@ -1,6 +1,9 @@
 import { Pipe, PipeTransform } from '@angular/core';
 import { DomSanitizer } from '@angular/platform-browser';
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'paginationTotalPagesFormat',
     standalone: true

diff --git a/src/table/pipes/drag.pipe.ts b/src/table/pipes/drag.pipe.ts
@@ -2,6 +2,9 @@ import { SafeAny } from 'ngx-tethys/types';
 
 import { Pipe, PipeTransform } from '@angular/core';
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'tableRowDragDisabled',
     standalone: true

diff --git a/src/table/pipes/table.pipe.ts b/src/table/pipes/table.pipe.ts
@@ -1,5 +1,8 @@
 import { Pipe, PipeTransform } from '@angular/core';
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'isValidModelValue',
     standalone: true

diff --git a/src/tree/tree.pipe.ts b/src/tree/tree.pipe.ts
@@ -2,6 +2,9 @@ import { Pipe, PipeTransform } from '@angular/core';
 import { ThyTreeNode } from './tree-node.class';
 import { ThyTreeBeforeDragStartContext } from './tree.class';
 
+/**
+ * @private
+ */
 @Pipe({
     name: 'treeNodeDraggable',
     standalone: true