Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More docu #95

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
fef3f69
Create draft PR for #65
Specter-13 Feb 14, 2023
d962d92
added fundamentals for ix-doc compiler
Specter-13 Feb 16, 2023
5cc9b11
Added GetComments method
Brano5 Feb 17, 2023
e0e2ce8
refactoring, fix wrong names of some generated yaml files
Specter-13 Feb 17, 2023
2ad333b
Added NamedValueType and StructuredType method for generating Types a…
Brano5 Feb 17, 2023
fa47c99
added experimental implementation of inherited members
Specter-13 Feb 17, 2023
4e4ec51
wip on inherited members, some refactoring
Specter-13 Feb 17, 2023
ea5b0ca
fix canbefieldinherited method
Specter-13 Feb 17, 2023
2e806c3
Refactor PopulateItem
Brano5 Feb 20, 2023
4db854b
Added namespace
Brano5 Feb 20, 2023
7b20f3b
added basic implementation of references for inherited members
Feb 20, 2023
71b6f9f
merge with toc namespace grouping
Feb 20, 2023
13c50e5
Merge branch 'dev' into 65-Explore_possibilities_of_documentation_com…
Feb 20, 2023
5a55519
some refactoring, added custom files for namespaces and references fo…
Feb 20, 2023
f254a0f
Small refactoring
Brano5 Feb 20, 2023
29b3af9
Added type of properties in class
Brano5 Feb 22, 2023
c7d277e
Change struct for Param comments to Dictionary
Brano5 Feb 22, 2023
f73c0a7
Removed Assemblies from Class
Brano5 Feb 22, 2023
4e6dc9f
added input parameters and declarations for methods
Feb 22, 2023
031a449
Merge branch '65-Explore_possibilities_of_documentation_compiler_for_…
Feb 22, 2023
f31ad66
id for method depends on its parameters, some refactoring
Feb 22, 2023
1dd8d82
Added generating docs for type
Brano5 Feb 22, 2023
beb2088
Merge Removed Assemblies from Class and Added generating docs for typ…
Brano5 Feb 22, 2023
603b625
Refactor CodeToYamlMapper
Brano5 Feb 22, 2023
c897efc
Added references to return value in method
Brano5 Feb 22, 2023
06aef9d
Delete AddInputParameterItems
Brano5 Feb 23, 2023
5031d31
some refactoring, added basic documentation
Feb 23, 2023
3fd6c15
Added option to add remark, code and c in docs
Brano5 Feb 23, 2023
b7a8862
Merge branch '65-Explore_possibilities_of_documentation_compiler_for_…
Feb 23, 2023
8eca675
Added interface generating to docs
Brano5 Feb 23, 2023
62d6e94
Merge branch '65-Explore_possibilities_of_documentation_compiler_for_…
Brano5 Feb 23, 2023
b345d18
Update documentation
Brano5 Feb 24, 2023
d6e6c0c
Rename TocSchemaList to TocSchema - deleted old TocSchema
Brano5 Feb 24, 2023
e2002a3
fix references and method parameters, added legal acrobatics
Feb 24, 2023
00c4151
merge commit
Feb 24, 2023
a09af91
refactoring, delete existing yml files
Feb 24, 2023
9f9ae91
change folder name to ixd
Feb 24, 2023
3d834c6
small refactoring
Feb 24, 2023
9e401fa
Merge branch 'dev' into 65-Explore_possibilities_of_documentation_com…
Feb 24, 2023
9d99e43
[ixd] preps for packaging
PTKu Feb 24, 2023
edb0ec7
adds more docu for connectors
PTKu Feb 24, 2023
67a5796
Merge branch 'dev' into 65-Explore_possibilities_of_documentation_com…
PTKu Feb 24, 2023
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
4 changes: 4 additions & 0 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@

* ---
* [Connectors](/articles/connectors/README.md)
* [Dummy](/articles/connectors/Dummy.md)
* [WebAPI](/articles/connectors/WebAPI.md)
* ---
* [Documenation compiler](/articles/ixd/IXD.md)
* ---
* [Blazor rendering](/articles/blazor/README.md)
* [Blazor layouts](/articles/blazor/LAYOUTS.md)
Expand Down
5 changes: 4 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@
* [Added members](/articles/compiler/ADDED_MEMBERS.md)
* [Config file](/articles/compiler/CONFIG_FILE.md)
* [Packaging and dependencies](/articles/compiler/PACKAGING.md)

* ---
* [Documenation compiler](/articles/ixd/IXD.md)
* ---
* [Connectors](/articles/connectors/README.md)
* [Dummy](/articles/connectors/Dummy.md)
* [WebAPI](/articles/connectors/WebAPI.md)
* ---
* [Blazor rendering](/articles/blazor/README.md)
* [Blazor layouts](/articles/blazor/LAYOUTS.md)
Expand Down
9 changes: 9 additions & 0 deletions docs/articles/connectors/Dummy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Dummy

### [API](../../api/Ix.Connector/Ix.Connector/DummyConnector.md)

Provides the possibility to work with PLC twins without target system.

~~~C#
public static <PLC_TWIN_TYPE> Plc { get; } = new(ConnectorAdapterBuilder.Build().CreateDummy());
~~~
8 changes: 3 additions & 5 deletions docs/articles/connectors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,10 +306,8 @@ HumanReadable property is the concatenation of AttributeName properties in the t

HumanReadable from `TurnLightsOff` is `App.Settings.Lights off`

## [Dummy](../../api/Ix.Connector/Ix.Connector/DummyConnector.md)

Provides the possibility to work with PLC twins without target system.
See also

## [WebAPI](../../api/Ix.Connector.Sax.WebAPI/Ix.Connector.Sax.WebAPI.md)
[Dummy Connector](Dummy.md)

Provides connectivity to S7-15XX PLC systems using WebAPI interface.
[WebAPI Connector](WebAPI.md)
9 changes: 9 additions & 0 deletions docs/articles/connectors/WebAPI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# WebAPI Connector

## [API](../../api/Ix.Connector.S71500.WebAPI/Ix.Connector.S71500.WebAPI.md)

Provides connectivity to S7-15XX PLC systems using WebAPI interface.

~~~C#
public static <PLC_TWIN_TYPE> Plc { get; } = new (ConnectorAdapterBuilder.Build().CreateWebApi(Environment.GetEnvironmentVariable("AXTARGET") ?? "10.10.101.1", "Everybody", "", true));
~~~
15 changes: 11 additions & 4 deletions docs/articles/ixd/IXD.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,26 @@ Docfx project will be generated with following folder structure:
```


### 3. Generate documentation with ixd
### 3. Install ixd tool

~~~
dotnet tool install Ix.ixd --prerelease --local
~~~

### 4. Generate documentation with ixd



```
ixd -x $PATH_TO_AX_PROJECT -o $PATH_TO_API_FOLDER
```
dotnet ixd -x $PATH_TO_AX_PROJECT -o $PATH_TO_API_FOLDER
=======

where:

`$PATH_TO_AX_PROJECT` -- is path to AX project, which contains apax.yml file
`$PATH_TO_API_FOLDER` -- is path to `api` output folder, which is located in docfx project

### 4. Build and run docfx docset
### 5. Build and run docfx docset

Enter following command in `docfx_project` project directory:

Expand Down