Skip to content

Commit 9ae3b63

Browse files
ssupdocmmalerba
authored andcommitted
Fix docs api section (#17622)
* docs(cdk/clipboard) Example usage in clipboard API section Updates the `clipboard` documentation to avoid example usage in API section section as codes are not formatted in the API section. Fixes #17579 * docs(cdk/tree) Example usage in API section of tree Updates documentation to avoid example usage for `nested node` in `tree`, as codes are not properly formatted in the API sections. Fixes #17579
1 parent ab0095e commit 9ae3b63

File tree

3 files changed

+1
-24
lines changed

3 files changed

+1
-24
lines changed

src/cdk/clipboard/clipboard.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ import {PendingCopy} from './pending-copy';
1313

1414
/**
1515
* A service for copying text to the clipboard.
16-
*
17-
* Example usage:
18-
*
19-
* clipboard.copy("copy this text");
2016
*/
2117
@Injectable({providedIn: 'root'})
2218
export class Clipboard {

src/cdk/clipboard/copy-to-clipboard.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@ import {Clipboard} from './clipboard';
1313
/**
1414
* Provides behavior for a button that when clicked copies content into user's
1515
* clipboard.
16-
*
17-
* Example usage:
18-
*
19-
* `<button copyToClipboard="Content to be copied">Copy me!</button>`
2016
*/
2117
@Directive({
2218
selector: '[cdkCopyToClipboard]',

src/cdk/tree/nested-node.ts

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,7 @@ import {getTreeControlFunctionsMissingError} from './tree-errors';
2626
* Nested node is a child of `<cdk-tree>`. It works with nested tree.
2727
* By using `cdk-nested-tree-node` component in tree node template, children of the parent node will
2828
* be added in the `cdkTreeNodeOutlet` in tree node template.
29-
* For example:
30-
* ```html
31-
* <cdk-nested-tree-node>
32-
* {{node.name}}
33-
* <ng-template cdkTreeNodeOutlet></ng-template>
34-
* </cdk-nested-tree-node>
35-
* ```
36-
* The children of node will be automatically added to `cdkTreeNodeOutlet`, the result dom will be
37-
* like this:
38-
* ```html
39-
* <cdk-nested-tree-node>
40-
* {{node.name}}
41-
* <cdk-nested-tree-node>{{child1.name}}</cdk-nested-tree-node>
42-
* <cdk-nested-tree-node>{{child2.name}}</cdk-nested-tree-node>
43-
* </cdk-nested-tree-node>
44-
* ```
29+
* The children of node will be automatically added to `cdkTreeNodeOutlet`.
4530
*/
4631
@Directive({
4732
selector: 'cdk-nested-tree-node',

0 commit comments

Comments
 (0)