Skip to content

Commit 4cfd511

Browse files
PTKuPTKu
authored
Merge pull request #923 from Inxton/docs-and-various
Docs and various
2 parents d3098ac + 17bab86 commit 4cfd511

File tree

58 files changed

+503
-92
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+503
-92
lines changed

‎.config/dotnet-tools.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"isRoot": true,
44
"tools": {
55
"AXSharp.ixc": {
6-
"version": "0.46.0-alpha.356",
6+
"version": "0.46.0-alpha.363",
77
"commands": [
88
"ixc"
99
],
@@ -17,14 +17,14 @@
1717
"rollForward": false
1818
},
1919
"AXSharp.ixd": {
20-
"version": "0.46.0-alpha.356",
20+
"version": "0.46.0-alpha.363",
2121
"commands": [
2222
"ixd"
2323
],
2424
"rollForward": false
2525
},
2626
"AXSharp.ixr": {
27-
"version": "0.46.0-alpha.356",
27+
"version": "0.46.0-alpha.363",
2828
"commands": [
2929
"ixr"
3030
],
@@ -53,3 +53,5 @@
5353
}
5454
}
5555
}
56+
57+

‎Directory.Packages.props‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
<!-- Framework-Agnostic Packages -->
1212
<ItemGroup>
1313
<!-- AX# Libraries -->
14-
<PackageVersion Include="AXSharp.Abstractions" Version="0.46.0-alpha.356" />
15-
<PackageVersion Include="AXSharp.Connector" Version="0.46.0-alpha.356" />
16-
<PackageVersion Include="AXSharp.Connector.S71500.WebAPI" Version="0.46.0-alpha.356" />
17-
<PackageVersion Include="AXSharp.Presentation.Blazor" Version="0.46.0-alpha.356" />
18-
<PackageVersion Include="AXSharp.Presentation.Blazor.Controls" Version="0.46.0-alpha.356" />
14+
<PackageVersion Include="AXSharp.Abstractions" Version="0.46.0-alpha.363" />
15+
<PackageVersion Include="AXSharp.Connector" Version="0.46.0-alpha.363" />
16+
<PackageVersion Include="AXSharp.Connector.S71500.WebAPI" Version="0.46.0-alpha.363" />
17+
<PackageVersion Include="AXSharp.Presentation.Blazor" Version="0.46.0-alpha.363" />
18+
<PackageVersion Include="AXSharp.Presentation.Blazor.Controls" Version="0.46.0-alpha.363" />
1919
<PackageVersion Include="Inxton.Operon" Version="0.3.0-alpha.100" />
2020
<!-- Data & Serialization -->
2121
<PackageVersion Include="ClosedXML" Version="0.105.0" />
@@ -88,3 +88,5 @@
8888
<PackageVersion Include="Microsoft.Build.Tasks.Core" Version="18.0.2" />
8989
</ItemGroup>
9090
</Project>
91+
92+

‎docfx/api/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# IX API Documentation
1+
# .NET API Documentation
22

33
![](~/images/banner.png)

‎docfx/apictrl/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Controller API Documentation
2+
3+
![](~/images/banner.png)
4+
5+
This section contains the API documentation for AXOpen PLC controller libraries. These APIs are designed for use in SIMATIC AX PLC programming environments.
6+
7+
## Overview
8+
9+
The controller APIs provide structured types, function blocks, and interfaces for building industrial automation applications. The documentation covers:
10+
11+
- **Core** - Base classes and interfaces for objects, tasks, components, and sequencers
12+
- **Data** - Data exchange and CRUD operations for persistent and local data
13+
- **Components** - Ready-to-use components for various industrial equipment:
14+
- Vision systems (Cognex)
15+
- Drives (Festo, Rexroth)
16+
- Robotics (KUKA, Mitsubishi)
17+
- Pneumatics and basic elements
18+
- **Inspectors** - Quality inspection and validation frameworks
19+
- **Logging & Messaging** - Diagnostic and communication services
20+
21+
Browse the API reference using the table of contents to explore specific namespaces and types.

‎docfx/apidoc/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
1+
# APIs
12

3+
![](~/images/banner.png)
24

5+
## API Documentation
6+
7+
Browse the API documentation for different platforms:
8+
9+
- [.NET API](../api/index.md) - .NET libraries for application development
10+
- [CONTROLLER API](../apictrl/index.md) - PLC controller libraries for SIMATIC AX

‎docfx/components/toc.yml‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@
1111
href: ../components.desoutter.tightening/docs/index.html
1212
- name: Drives
1313
href: ../components.drives/docs/index.html
14+
- name: Dukane Welders
15+
href: ../components.dukane.welders/docs/index.html
1416
- name: Elements
1517
href: ../components.elements/docs/index.html
1618
- name: Festo Drives
1719
href: ../components.festo.drives/docs/index.html
20+
- name: Keyence Vision
21+
href: ../components.keyence.vision/docs/index.html
1822
- name: Kuka Robotics
1923
href: ../components.kuka.robotics/docs/index.html
2024
- name: Mitsubishi Robotics
@@ -24,12 +28,18 @@
2428
- name: Rexroth Drives
2529
href: ../components.rexroth.drives/docs/index.html
2630
- name: Rexroth Press
27-
href: ../components.rexroth.press/docs/index.html
31+
href: ../components.rexroth.press/docs/index.html
32+
- name: Rexroth Tightening
33+
href: ../components.rexroth.tightening/docs/index.html
2834
- name: Robotics
2935
href: ../components.robotics/docs/index.html
30-
- name: Siemens Identification
31-
href: ../components.siemens.identification/docs/index.html
36+
- name: Siem Communication
37+
href: ../components.siem.communication/docs/index.html
38+
- name: Siem Identification
39+
href: ../components.siem.identification/docs/index.html
3240
- name: Ur Robotics
3341
href: ../components.ur.robotics/docs/index.html
42+
- name: Zebra Vision
43+
href: ../components.zebra.vision/docs/index.html
3444
- name: Library template
3545
href: ../template.axolibrary/docs/index.html

‎docfx/docfx.json‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,27 @@
99
"core/src/**.csproj",
1010
"data/src/**.csproj",
1111
"inspectors/src/**.csproj",
12+
"components.abb.robotics/src/**.csproj",
13+
"components.abstractions/src/**.csproj",
14+
"components.balluff.identification/src/**.csproj",
1215
"components.cognex.vision/src/**.csproj",
13-
"components.pneumatics/src/**.csproj",
16+
"components.desoutter.tightening/src/**.csproj",
17+
"components.drives/src/**.csproj",
18+
"components.dukane.welders/src/**.csproj",
1419
"components.elements/src/**.csproj",
20+
"components.festo.drives/src/**.csproj",
21+
"components.keyence.vision/src/**.csproj",
22+
"components.kuka.robotics/src/**.csproj",
23+
"components.mitsubishi.robotics/src/**.csproj",
24+
"components.pneumatics/src/**.csproj",
25+
"components.rexroth.drives/src/**.csproj",
26+
"components.rexroth.press/src/**.csproj",
27+
"components.rexroth.tightening/src/**.csproj",
28+
"components.robotics/src/**.csproj",
29+
"components.siem.communication/src/**.csproj",
30+
"components.siem.identification/src/**.csproj",
31+
"components.ur.robotics/src/**.csproj",
32+
"components.zebra.vision/src/**.csproj",
1533
"template.axolibrary/src/**.csproj"
1634
],
1735
"exclude": [
@@ -20,7 +38,8 @@
2038
"**/obj/**",
2139
"*.Properties",
2240
"*.Resx",
23-
"*.g.cs"
41+
"*.g.cs",
42+
"**/node_modules/**"
2443
],
2544
"src": "../src/"
2645
}

‎scripts/build_test_docu.ps1‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ dotnet ixd `
1111
.\src\components.festo.drives\ctrl `
1212
.\src\components.kuka.robotics\ctrl `
1313
.\src\components.mitsubishi.robotics\ctrl `
14-
.\src\template.axolibrary\ctrl `
1514
-o .\docfx\apictrl\
1615

1716
if ((Test-Path .\docs-test\)) {
1817
del .\docs-test\
1918
}
2019

20+
# Generate metadata (API documentation) from C# projects
21+
# dotnet docfx metadata .\docfx\docfx.json
22+
23+
# Build the documentation site
2124
dotnet docfx build .\docfx\docfx.json --output .\docs-test\
2225
dotnet docfx serve .\docs-test\ --open-browser

‎src/components.abb.robotics/src/AXOpen.Components.Abb.Robotics/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,3 @@ dotnet add package AXOpen.Components.Abb.Robotics --version {axopen-version}
1616
~~~xml
1717
<PackageReference Include="AXOpen.Components.Abb.Robotics" Version="{axopen-version}" />
1818
~~~
19-
20-
<!-- TODO: Additional information about partial extensions -->

‎src/components.abstractions/ctrl/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# @inxton/axopen.components.abstractions
2+
3+
[!INCLUDE [General](../docs/README.md)]
4+
5+
[!INCLUDE [General](../../../docfx/articles/notes/APAX_PACAKGE_GENERAL.md)]
6+
7+
8+
## Adding the package to your project
9+
~~~bash
10+
apax add "@inxton/axopen.components.abstractions"
11+
~~~
12+
13+
## Modifying your `apax.yml`
14+
15+
~~~yml
16+
dependencies:
17+
"@inxton/axopen.components.abstractions": '{axopen-version}'
18+
~~~

0 commit comments

Comments
 (0)