[ADF-3323] Updated doc tools to use DocFX intermediate files (#3601)

* [ADF-3323] Moved source file parsing to main doc tool

* [ADF-3323] Moved source info classes

* [ADF-3323] Added doc YAML generator tool

* [ADF-3323] Added doc YAML/JSON source paths to gitignore

* [ADF-3323] Completed templates and template context code

* [ADF-3323] Added source paths and updated type linker

* [ADF-3323] Final fixes to templates and type linking

* [ADF-3323] Fixed filter for private and protected methods

* [ADF-3323] Content services docs after check and rebuild

* [ADF-3323] Updated docbuild script in package.json
This commit is contained in:
Andy Stark
2018-07-18 18:59:53 +01:00
committed by Eugenio Romano
parent 54380fd693
commit 69d8ff147e
61 changed files with 1437 additions and 731 deletions

View File

@@ -10,14 +10,10 @@ Provides access to Webscript features.
## Contents
- [Basic usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Webscript View HTML example](#webscript-view-html-example)
- [Webscript View DATATABLE example](#webscript-view-datatable-example)
- [Webscript View JSON example](#webscript-view-json-example)
@@ -38,7 +34,7 @@ Provides access to Webscript features.
Another example:
**app.component.html**
**[app.component](demo-shell/src/app/app.component.ts).html**
```html
<adf-webscript-get
@@ -50,7 +46,7 @@ Another example:
</adf-webscript-get>
```
**app.component.ts**
**[app.component](demo-shell/src/app/app.component.ts).ts**
```ts
export class AppComponent {
@@ -65,7 +61,7 @@ export class AppComponent {
### Properties
| Name | Type | Default value | Description |
| -- | -- | -- | -- |
| ---- | ---- | ------------- | ----------- |
| contentType | `string` | "TEXT" | Content type to interpret the data received from the webscript. Can be "JSON" , "HTML" , "DATATABLE" or "TEXT" |
| contextRoot | `string` | "alfresco" | Path where the application is deployed |
| scriptArgs | `any` | | Arguments to pass to the webscript. |
@@ -76,7 +72,7 @@ export class AppComponent {
### Events
| Name | Type | Description |
| -- | -- | -- |
| ---- | ---- | ----------- |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the operation succeeds. You can get the plain data from the webscript through the **success** event parameter and use it as you need in your application. |
## Details