Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": 1,
"isRoot": true,
"tools": {
"docfx": {
"version": "2.73.0",
"commands": [
"docfx"
]
}
}
}
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,7 @@ package/build:
plugins/build:
make -C Plugins/CoreBluetoothForUnity dylib
make -C Plugins/CoreBluetoothForUnity framework

.PHONY: docs/clean
docs/clean:
rm -rf ./docs/_site
9 changes: 9 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
5 changes: 5 additions & 0 deletions docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
66 changes: 66 additions & 0 deletions docs/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"metadata": [
{
"src": [
{
"files": [
"Packages/com.teach310.core-bluetooth-for-unity/Runtime/**/*.cs"
],
"exclude": [
"Packages/com.teach310.core-bluetooth-for-unity/Runtime/Initializer.cs",
"Packages/com.teach310.core-bluetooth-for-unity/Runtime/NativeCallbacks/*.cs"
],
"src": ".."
}
],
"dest": "api",
"outputFormat": "mref",
"includePrivateMembers": false,
"disableGitFeatures": false,
"disableDefaultFilter": false,
"filter": "filterConfig.yml",
"noRestore": false,
"namespaceLayout": "flattened",
"memberLayout": "samePage",
"enumSortOrder": "declaringOrder",
"allowCompilationErrors": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml"
]
},
{
"files": [
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"globalMetadata": {
"_appTitle": "CoreBluetoothForUnity",
"_appName": "CoreBluetoothForUnity",
"_enableSearch": true,
"_enableNewTab": true
},
"fileMetadataFiles": [],
"template": [
"default",
"modern"
],
"postProcessors": [],
"keepFileLink": false,
"disableGitFeatures": false
}
}
7 changes: 7 additions & 0 deletions docs/filterConfig.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
apiRules:
- exclude:
uidRegex: ^System\.Object
type: Type
- exclude:
uidRegex: ^CoreBluetooth\.Foundation
type: Namespace
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CoreBluetoothForUnity

Provides native Apple CoreBluetooth integration for use with Unity.

https://github.com/teach310/CoreBluetoothForUnity
6 changes: 6 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- name: Api Documentation
href: api/
homepage: api/CoreBluetooth.yml

- name: Repository
href: https://github.com/teach310/CoreBluetoothForUnity