@natec/mef-dev-ui-kit 0.0.670 → 0.0.671
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +97 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,3 +22,100 @@ Run `ng test mef-dev-ui-tool-kit` to execute the unit tests via [Karma](https://
|
|
|
22
22
|
## Further help
|
|
23
23
|
|
|
24
24
|
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
|
|
25
|
+
|
|
26
|
+
# doc tips
|
|
27
|
+
```
|
|
28
|
+
/**
|
|
29
|
+
* Example of usage:
|
|
30
|
+
* <example-url>http://localhost/demo/mysample.component.html</example-url>
|
|
31
|
+
* <example-url>/demo/mysample.component.html</example-url>
|
|
32
|
+
*/
|
|
33
|
+
```
|
|
34
|
+
```
|
|
35
|
+
/**
|
|
36
|
+
* This is my class
|
|
37
|
+
* @deprecated This class is deprecated
|
|
38
|
+
*/
|
|
39
|
+
class MyClass {}
|
|
40
|
+
```
|
|
41
|
+
```
|
|
42
|
+
/**
|
|
43
|
+
* @param {string} target The target to process
|
|
44
|
+
* @returns The processed target number
|
|
45
|
+
*/
|
|
46
|
+
function processTarget(target:string):number;
|
|
47
|
+
```
|
|
48
|
+
```@ignore, @internal
|
|
49
|
+
/**
|
|
50
|
+
* @ignore
|
|
51
|
+
*/
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
```
|
|
55
|
+
/**
|
|
56
|
+
* @example
|
|
57
|
+
* This is a good example
|
|
58
|
+
* processTarget('yo')
|
|
59
|
+
*
|
|
60
|
+
* @param {string} target The target to process see {@link Todo}
|
|
61
|
+
* @returns The processed target number
|
|
62
|
+
*/
|
|
63
|
+
function processTarget(target:string):number;
|
|
64
|
+
```
|
|
65
|
+
```
|
|
66
|
+
/**
|
|
67
|
+
* Shows all events on a given day. Example usage:
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* <mwl-calendar-day-view
|
|
71
|
+
* [viewDate]="viewDate"
|
|
72
|
+
* [events]="events">
|
|
73
|
+
* </mwl-calendar-day-view>
|
|
74
|
+
*/
|
|
75
|
+
```
|
|
76
|
+
# doc options
|
|
77
|
+
-h, --help output usage information
|
|
78
|
+
-V, --version output the version number
|
|
79
|
+
-c, --config [config] A configuration file : .compodocrc, .compodocrc.json, .compodocrc.yaml or compodoc property in package.json
|
|
80
|
+
-p, --tsconfig [config] A tsconfig.json file
|
|
81
|
+
-d, --output [folder] Where to store the generated documentation
|
|
82
|
+
-y, --extTheme [file] External styling theme
|
|
83
|
+
-n, --name [name] Title of the documentation
|
|
84
|
+
-a, --assetsFolder [folder] External assets folder to copy in generated documentation folder
|
|
85
|
+
-o, --open Open the generated documentation
|
|
86
|
+
-t, --silent In silent mode, log messages aren't logged in the console
|
|
87
|
+
-s, --serve Serve generated documentation (default http://localhost:8080/)
|
|
88
|
+
-r, --port [port] Change default serving port
|
|
89
|
+
-w, --watch Watch source files after serve and force documentation rebuild
|
|
90
|
+
-e, --exportFormat [format] Export in specified format (json, html (default))
|
|
91
|
+
--language [language] Language used for the generated documentation (de-DE, en-US, es-ES, fr-FR, hu-HU, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, sk-SK, zh-CN) (default: en-US)
|
|
92
|
+
--theme [theme] Choose one of available themes, default is 'gitbook' (laravel, original, material, postmark, readthedocs, stripe, vagrant)
|
|
93
|
+
--hideGenerator Do not print the Compodoc logo at the bottom of the page
|
|
94
|
+
--toggleMenuItems Close by default items in the menu (default ['all']) values : ['all'] or one of these ['modules','components','directives','controllers','classes','injectables','guards','interfaces','interceptors','pipes','miscellaneous','additionalPages'])
|
|
95
|
+
--navTabConfig List navigation tab objects in the desired order with two string properties ("id" and "label"). Double-quotes must be escaped with '\'. Available tab IDs are "info", "readme", "source", "templateData", "tree", and "example". Note: Certain tabs will only be shown if applicable to a given dependency
|
|
96
|
+
--templates [folder] Path to directory of Handlebars templates to override built-in templates
|
|
97
|
+
--includes [path] Path of external markdown files to include
|
|
98
|
+
--includesName [name] Name of item menu of externals markdown files (default "Additional documentation")
|
|
99
|
+
--coverageTest Test command of documentation coverage with a threshold (default 70)
|
|
100
|
+
--coverageMinimumPerFile [minimum] Test command of documentation coverage per file with a minimum (default 0)
|
|
101
|
+
--coverageTestThresholdFail [boolean] Test command of documentation coverage (global or per file) will fail with error or just warn user (true: error, false: warn) (default: true)
|
|
102
|
+
--coverageTestShowOnlyFailed Display only failed files for a coverage test
|
|
103
|
+
--unitTestCoverage [json-summary] To include unit test coverage, specify istanbul JSON coverage summary file
|
|
104
|
+
--disableSourceCode Do not add source code tab and links to source code
|
|
105
|
+
--disableDomTree Do not add dom tree tab
|
|
106
|
+
--disableTemplateTab Do not add template tab
|
|
107
|
+
--disableStyleTab Do not add style tab
|
|
108
|
+
--disableGraph Disable rendering of the dependency graph
|
|
109
|
+
--disableCoverage Do not add the documentation coverage report
|
|
110
|
+
--disablePrivate Do not show private in generated documentation
|
|
111
|
+
--disableProtected Do not show protected in generated documentation
|
|
112
|
+
--disableInternal Do not show @internal in generated documentation
|
|
113
|
+
--disableLifeCycleHooks Do not show Angular lifecycle hooks in generated documentation
|
|
114
|
+
--disableRoutesGraph Do not add the routes graph
|
|
115
|
+
--disableSearch Do not add the search input
|
|
116
|
+
--disableDependencies Do not add the dependencies list
|
|
117
|
+
--minimal Minimal mode with only documentation. No search, no graph, no coverage.
|
|
118
|
+
--customFavicon [path] Use a custom favicon
|
|
119
|
+
--customLogo [path] Use a custom logo
|
|
120
|
+
--gaID [id] Google Analytics tracking ID
|
|
121
|
+
--gaSite [site] Google Analytics site name (default auto (default: auto)
|