Skip to content

Commit 9483c0f

Browse files
committed
configuring for Typescript
1 parent b04277b commit 9483c0f

File tree

4 files changed

+111
-35
lines changed

4 files changed

+111
-35
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ _site/
44
.optemp/
55
_themes*/
66
_repo.*/
7+
_dependentPackages/
78

89
.openpublishing.buildcore.ps1

.openpublishing.publish.config.json

+45-34
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,47 @@
11
{
2-
"need_generate_pdf": false,
3-
"need_generate_intellisense": false,
4-
"docsets_to_publish": [
5-
{
6-
"docset_name": "SP-Framework",
7-
"build_source_folder": "SP-Framework",
8-
"build_output_subfolder": "SP-Framework",
9-
"locale": "en-us",
10-
"monikers": [],
11-
"moniker_ranges": [],
12-
"open_to_public_contributors": true,
13-
"type_mapping": {
14-
"Conceptual": "Content",
15-
"ManagedReference": "Content",
16-
"RestApi": "Content"
17-
},
18-
"build_entry_point": "docs",
19-
"template_folder": "_themes"
20-
}
21-
],
22-
"notification_subscribers": [],
23-
"branches_to_filter": [],
24-
"skip_source_output_uploading": false,
25-
"need_preview_pull_request": false,
26-
"dependent_repositories": [
27-
{
28-
"path_to_root": "_themes",
29-
"url": "https://github.com/Microsoft/templates.docs.msft",
30-
"branch": "master",
31-
"branch_mapping": {}
32-
}
33-
],
34-
"branch_target_mapping": {},
35-
"need_generate_pdf_url_template": false
2+
"need_generate_pdf": false,
3+
"need_generate_intellisense": false,
4+
"docsets_to_publish": [
5+
{
6+
"docset_name": "SP-Framework",
7+
"build_source_folder": "SP-Framework",
8+
"build_output_subfolder": "SP-Framework",
9+
"locale": "en-us",
10+
"monikers": [],
11+
"moniker_ranges": [],
12+
"open_to_public_contributors": true,
13+
"type_mapping": {
14+
"Conceptual": "Content",
15+
"UniversalReference": "Content"
16+
},
17+
"build_entry_point": "docs",
18+
"template_folder": "_themes",
19+
"customized_template_paths": [
20+
"_dependentPackages/uref/content"
21+
]
22+
}
23+
],
24+
"notification_subscribers": [],
25+
"branches_to_filter": [],
26+
"skip_source_output_uploading": false,
27+
"need_preview_pull_request": false,
28+
"dependent_repositories": [
29+
{
30+
"path_to_root": "_themes",
31+
"url": "https://github.com/Microsoft/templates.docs.msft",
32+
"branch": "master",
33+
"branch_mapping": {}
34+
}
35+
],
36+
"dependent_packages": [
37+
{
38+
"id": "opbuild.templates.uref",
39+
"nuget_feed": "https://www.myget.org/F/op/api/v2",
40+
"path_to_root": "_dependentPackages/uref",
41+
"target_framework": "net45",
42+
"version": "latest"
43+
}
44+
],
45+
"branch_target_mapping": {},
46+
"need_generate_pdf_url_template": false
3647
}

SP-Framework/docfx.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"content": [
44
{
55
"files": [
6-
"**/*.md"
6+
"**/*.md",
7+
"**/*.yml"
78
],
89
"exclude": [
910
"**/obj/**",

SP-Framework/sample.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
### YamlMime:UniversalReference
2+
items:
3+
- uid: azure-iot-device.Client
4+
fullName: azure-iot-device.Client
5+
name: Client
6+
package: azure-iot-device
7+
summary: Creates an IoT Hub device client. Normally, consumers will call the factory method, @azure-iot-device.Client.fromConnectionString(string,Transport), to create an IoT Hub device client
8+
source:
9+
path: lib\services\advisorManagement\lib\operations\operations.js
10+
startLine: 276
11+
remote:
12+
branch: jsdoc
13+
path: lib\services\advisorManagement\lib\operations\operations.js
14+
repo: 'https://github.com/Azure/azure-sdk-for-node.git'
15+
type: class
16+
langs:
17+
- typeScript
18+
children:
19+
- azure-iot-device.Client.#ctor(Transport,string,BlobUploadClient)
20+
- azure-iot-device.Client.fromConnectionString(string,Transport)
21+
- uid: azure-iot-device.Client.#ctor(Transport,string,BlobUploadClient)
22+
fullName: azure-iot-device.Client.#ctor(Transport,string,BlobUploadClient)
23+
name: Client(Transport,string,BlobUploadClient)
24+
type: constructor
25+
syntax:
26+
content: 'constructor(transport: Transport, connStr?: string, blobUploadClient?: BlobUploadClient)'
27+
parameters:
28+
- id: transport
29+
type:
30+
- Transport
31+
description: An object that implements the interface expected of a transport object, e.g., Http.
32+
- id: connStr
33+
type:
34+
- string
35+
description: 'A connection string (optional: when not provided, updateSharedAccessSignature must be called to set the SharedAccessSignature token directly).'
36+
- id: blobUploadClient
37+
type:
38+
- BlobUploadClient
39+
description: An object that is capable of uploading a stream to a blob.
40+
- uid: azure-iot-device.Client.fromConnectionString(string,Transport)
41+
fullName: azure-iot-device.Client.fromConnectionString(string, Transport)
42+
name: fromConnectionString(string, Transport)
43+
summary: Creates an IoT Hub device client from the given connection string using the given transport type.
44+
type: method
45+
syntax:
46+
content: 'public static fromConnectionString(string, Transport)'
47+
parameters:
48+
- id: connStr
49+
type:
50+
- string
51+
description: A connection string which encapsulates "device connect" permissions on an IoT hub.
52+
- id: Transport
53+
type:
54+
- function
55+
description: A transport constructor.
56+
return:
57+
type:
58+
- azure-iot-device.Client
59+
exceptions:
60+
- type: ReferenceError
61+
description: If the connStr parameter is falsy.
62+
- type: ReferenceError222
63+
description: If the connStr parameter is falsy.

0 commit comments

Comments
 (0)