From 40a32421ec590ba630c8a726811143b315061396 Mon Sep 17 00:00:00 2001 From: Samuele Locatelli Date: Thu, 19 May 2022 12:44:43 +0200 Subject: [PATCH] Update documentazione x DocFx via *.md --- EgwProxy.Icoel/api/index.md | 3 +- EgwProxy.Icoel/articles/intro.md | 1 - EgwProxy.Icoel/index.md | 2 + EgwProxy.MultiCncLib/api/index.md | 10 ++++ EgwProxy.MultiCncLib/articles/intro.md | 9 ++++ EgwProxy.MultiCncLib/articles/toc.md | 1 + EgwProxy.MultiCncLib/docfx.json | 68 ++++++++++++++++++++++++++ EgwProxy.MultiCncLib/index.md | 15 ++++++ EgwProxy.MultiCncLib/toc.yml | 6 +++ EgwProxy.OsaiCncLib/api/index.md | 10 ++++ EgwProxy.OsaiCncLib/articles/intro.md | 9 ++++ EgwProxy.OsaiCncLib/articles/toc.md | 1 + EgwProxy.OsaiCncLib/docfx.json | 68 ++++++++++++++++++++++++++ EgwProxy.OsaiCncLib/index.md | 15 ++++++ EgwProxy.OsaiCncLib/toc.yml | 6 +++ 15 files changed, 222 insertions(+), 2 deletions(-) create mode 100644 EgwProxy.MultiCncLib/api/index.md create mode 100644 EgwProxy.MultiCncLib/articles/intro.md create mode 100644 EgwProxy.MultiCncLib/articles/toc.md create mode 100644 EgwProxy.MultiCncLib/docfx.json create mode 100644 EgwProxy.MultiCncLib/index.md create mode 100644 EgwProxy.MultiCncLib/toc.yml create mode 100644 EgwProxy.OsaiCncLib/api/index.md create mode 100644 EgwProxy.OsaiCncLib/articles/intro.md create mode 100644 EgwProxy.OsaiCncLib/articles/toc.md create mode 100644 EgwProxy.OsaiCncLib/docfx.json create mode 100644 EgwProxy.OsaiCncLib/index.md create mode 100644 EgwProxy.OsaiCncLib/toc.yml diff --git a/EgwProxy.Icoel/api/index.md b/EgwProxy.Icoel/api/index.md index 7830e29f..115b5eb1 100644 --- a/EgwProxy.Icoel/api/index.md +++ b/EgwProxy.Icoel/api/index.md @@ -1,4 +1,5 @@ - # EgwProxy.Icoel +Libreria di comunicazione con servizi ICOEL (SOAP) + Impiegare il menù laterale per navigare nel codice del progetto. \ No newline at end of file diff --git a/EgwProxy.Icoel/articles/intro.md b/EgwProxy.Icoel/articles/intro.md index 8e16f242..220bb53e 100644 --- a/EgwProxy.Icoel/articles/intro.md +++ b/EgwProxy.Icoel/articles/intro.md @@ -1,4 +1,3 @@ - # Logica di funzionamento impianto ICOEL: L'impianto Icoel prevede di comunicare in 3 modalità: diff --git a/EgwProxy.Icoel/index.md b/EgwProxy.Icoel/index.md index 648fdc34..48cad64a 100644 --- a/EgwProxy.Icoel/index.md +++ b/EgwProxy.Icoel/index.md @@ -3,6 +3,8 @@ Documentazione relativa alla libreria di interfaccia con il Sizer di ICOEL per le operazioni di R/W dei dati di batch di produzione. +Disponibile in forma di pacchetto nuget sul repo aziendale nexus.steamware.net. + Vedere la sezione Articles per maggiori informazioni sulle definizioni, l'impiego ed esempi. ## Articles diff --git a/EgwProxy.MultiCncLib/api/index.md b/EgwProxy.MultiCncLib/api/index.md new file mode 100644 index 00000000..ce285397 --- /dev/null +++ b/EgwProxy.MultiCncLib/api/index.md @@ -0,0 +1,10 @@ +# EgwProxy.MultiCncLib + +Libreria di comunicazione multi-target verso PLC. + +Esempi CNC supportati: + - FANUC + - OSAI + - SIEMENS + +Impiegare il menù laterale per navigare nel codice del progetto. \ No newline at end of file diff --git a/EgwProxy.MultiCncLib/articles/intro.md b/EgwProxy.MultiCncLib/articles/intro.md new file mode 100644 index 00000000..e2817823 --- /dev/null +++ b/EgwProxy.MultiCncLib/articles/intro.md @@ -0,0 +1,9 @@ +# EgwProxy.MultiCncLib: + +Libreria proxy di comunicazione con CNC + + - FANUC + - SIEMENS + - OSAI + +Installabile come nuget package da proxy aziendale diff --git a/EgwProxy.MultiCncLib/articles/toc.md b/EgwProxy.MultiCncLib/articles/toc.md new file mode 100644 index 00000000..89dec33f --- /dev/null +++ b/EgwProxy.MultiCncLib/articles/toc.md @@ -0,0 +1 @@ +#[Introduction](intro.md) diff --git a/EgwProxy.MultiCncLib/docfx.json b/EgwProxy.MultiCncLib/docfx.json new file mode 100644 index 00000000..bacb80c9 --- /dev/null +++ b/EgwProxy.MultiCncLib/docfx.json @@ -0,0 +1,68 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "*.csproj" + ], + "cwd": ".", + "exclude": [ + "**/obj/**", + "**/bin/**", + "_site/**" + ] + } + ], + "dest": "obj/api" + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml" + ], + "cwd": "obj" + }, + { + "files": [ + "api/*.md", + "articles/**.md", + "toc.yml", + "*.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "template": [ + "default" + ] + } +} \ No newline at end of file diff --git a/EgwProxy.MultiCncLib/index.md b/EgwProxy.MultiCncLib/index.md new file mode 100644 index 00000000..1c18c443 --- /dev/null +++ b/EgwProxy.MultiCncLib/index.md @@ -0,0 +1,15 @@ +# EgwProxy.MultiCncLib: + +Documentazione relativa alla libreria EgwProxy.MultiCncLib. + +Disponibile in forma di pacchetto nuget sul repo aziendale nexus.steamware.net. + +Vedere la sezione Articles per maggiori informazioni sulle definizioni, l'impiego ed esempi. + +## Articles + +Per maggiori dettagli, definizioni e demo funzionamento si rimanda alla sezione Articles + +## Api + +Per ogni dettaglio e riferimento alla libreria si rimanda alla sezione Api Documentation \ No newline at end of file diff --git a/EgwProxy.MultiCncLib/toc.yml b/EgwProxy.MultiCncLib/toc.yml new file mode 100644 index 00000000..7eee9ffb --- /dev/null +++ b/EgwProxy.MultiCncLib/toc.yml @@ -0,0 +1,6 @@ + +- name: Articles + href: articles/ +- name: API Documentation + href: obj/api/ + homepage: api/index.md diff --git a/EgwProxy.OsaiCncLib/api/index.md b/EgwProxy.OsaiCncLib/api/index.md new file mode 100644 index 00000000..4769181f --- /dev/null +++ b/EgwProxy.OsaiCncLib/api/index.md @@ -0,0 +1,10 @@ +# EgwProxy.OsaiCncLib + +Libreria di comunicazione verso PLC OSAI (classici). + +Esempi CNC supportati: + - OPEN (soap) + - CNDEX + - VB6 + +Impiegare il menù laterale per navigare nel codice del progetto. \ No newline at end of file diff --git a/EgwProxy.OsaiCncLib/articles/intro.md b/EgwProxy.OsaiCncLib/articles/intro.md new file mode 100644 index 00000000..bac371a3 --- /dev/null +++ b/EgwProxy.OsaiCncLib/articles/intro.md @@ -0,0 +1,9 @@ +# EgwProxy.OsaiCncLib: + +Libreria proxy di comunicazione con CNC Osai + + - OPEN + - CNDEX + - VB6 + +Installabile come nuget package da proxy aziendale diff --git a/EgwProxy.OsaiCncLib/articles/toc.md b/EgwProxy.OsaiCncLib/articles/toc.md new file mode 100644 index 00000000..89dec33f --- /dev/null +++ b/EgwProxy.OsaiCncLib/articles/toc.md @@ -0,0 +1 @@ +#[Introduction](intro.md) diff --git a/EgwProxy.OsaiCncLib/docfx.json b/EgwProxy.OsaiCncLib/docfx.json new file mode 100644 index 00000000..bacb80c9 --- /dev/null +++ b/EgwProxy.OsaiCncLib/docfx.json @@ -0,0 +1,68 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "*.csproj" + ], + "cwd": ".", + "exclude": [ + "**/obj/**", + "**/bin/**", + "_site/**" + ] + } + ], + "dest": "obj/api" + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml" + ], + "cwd": "obj" + }, + { + "files": [ + "api/*.md", + "articles/**.md", + "toc.yml", + "*.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "template": [ + "default" + ] + } +} \ No newline at end of file diff --git a/EgwProxy.OsaiCncLib/index.md b/EgwProxy.OsaiCncLib/index.md new file mode 100644 index 00000000..da475c85 --- /dev/null +++ b/EgwProxy.OsaiCncLib/index.md @@ -0,0 +1,15 @@ +# EgwProxy.OsaiCncLib: + +Documentazione relativa alla libreria EgwProxy.OsaiCncLib. + +Disponibile in forma di pacchetto nuget sul repo aziendale nexus.steamware.net. + +Vedere la sezione Articles per maggiori informazioni sulle definizioni, l'impiego ed esempi. + +## Articles + +Per maggiori dettagli, definizioni e demo funzionamento si rimanda alla sezione Articles + +## Api + +Per ogni dettaglio e riferimento alla libreria si rimanda alla sezione Api Documentation \ No newline at end of file diff --git a/EgwProxy.OsaiCncLib/toc.yml b/EgwProxy.OsaiCncLib/toc.yml new file mode 100644 index 00000000..7eee9ffb --- /dev/null +++ b/EgwProxy.OsaiCncLib/toc.yml @@ -0,0 +1,6 @@ + +- name: Articles + href: articles/ +- name: API Documentation + href: obj/api/ + homepage: api/index.md