diff --git a/docs/boilerplate.component.md b/docs/boilerplate.component.md new file mode 100644 index 0000000000..a6e9502aa7 --- /dev/null +++ b/docs/boilerplate.component.md @@ -0,0 +1,63 @@ +# Boilerplate component + +Shows how to write a Markdown file for a component. + +![Screenshot goes here if necessary](docassets/images/adf-toolbar-01.png) + + + + + + + + + + +## Basic Usage + + +```html + + +``` + +### Properties + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| prop1 | string | 'hello' | The property description in the table should be no more than a few sentences. Add extra description in the Details section if you need to. | +| prop2 | boolean | true | Prop tables should have name, type, default and description, in that order. Leave default value blank if appropriate. | + +### Events + +| Name | Description | +| --- | --- | +| someEvent | Keep description short for the table. Usually starts with "Emitted when..." | +| anotherEvent | Emitted when the user double-clicks a list node | + +## Details + +**Note: This is not a real component!** + +Copy the contents of this file when you create a new component doc and edit or remove bits of it +as necessary. Usually, the title should be derived from the Angular name with the kebab-case expanded +(so "task-details.component" becomes "Task Details component") but there is no need to stick to this +if it looks wrong to you. + +### Subsection + +You don't need to make subsections in the Details part but add them if they help with the +explanation. Add them as level 3 headings in the Details part only - to keep the consistency +of the docs, you shouldn't normally add any new level 1 or 2 sections to the Markdown. + + + + + \ No newline at end of file diff --git a/docs/boilerplate.service.md b/docs/boilerplate.service.md new file mode 100644 index 0000000000..0843eba5c3 --- /dev/null +++ b/docs/boilerplate.service.md @@ -0,0 +1,42 @@ +# Boilerplate service + +Shows how to write a Markdown file for a service. + +## Methods + +`someMethod(value: string = '')`
+Shows how to document a method. + +`anotherMethod(value: string = '')`
+Shows how to document a method. + +## Properties + +| Name | Type | Default | Description | +| --- | --- | --- | --- | +| prop1 | string | 'hello' | Many services don't need a properties table. Delete this section if you don't need it. | +| prop2 | boolean | true | Prop tables should have name, type, default and description, in that order. Leave default blank if appropriate. | + +## Details + +**Note: This is not a real component!** + +Copy the contents of this file when you create a new service doc and edit or remove bits of it +as necessary. Usually, the title should be derived from the Angular name with the kebab-case expanded +(so "page-title.service" becomes "Page Title service") but there is no need to stick to this +if it looks wrong to you. + +The main difference between service and component docs is that services usually have methods. Replace +the method signature and description with your own text but keep the <br> at the end of the +signature line. + +### Subsection + +You don't need to make subsections in the Details part but add them if they help with the +explanation. Add them as level 3 headings in the Details part only - to keep the consistency +of the docs, you shouldn't normally add any new level 1 or 2 sections to the Markdown. + + + + + \ No newline at end of file