Aggiunta preliminare DocFx in VStudio (da validare e testare uso)

This commit is contained in:
Samuele Locatelli
2022-05-13 19:15:11 +02:00
parent 58aff6724f
commit c51d483c32
7 changed files with 118 additions and 0 deletions
+4
View File
@@ -2,6 +2,10 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
#ignoro (per ora) DoxFx site autogenerato da MSBuild in VStudio
Icoel.Soap/_site/*
Icoel.Soap/*/*.md
# User-specific files
*.suo
*.user
+16
View File
@@ -13,6 +13,8 @@
<AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
<Deterministic>true</Deterministic>
<TargetFrameworkProfile />
<NuGetPackageImportStamp>
</NuGetPackageImportStamp>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<PlatformTarget>AnyCPU</PlatformTarget>
@@ -62,7 +64,10 @@
<Compile Include="Properties\AssemblyInfo.cs" />
</ItemGroup>
<ItemGroup>
<None Include="api\index.md" />
<None Include="App.config" />
<None Include="articles\intro.md" />
<None Include="articles\toc.md" />
<None Include="batch.ini">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
@@ -134,6 +139,10 @@
<None Include="Connected Services\SizerService\System.xsd">
<SubType>Designer</SubType>
</None>
<None Include="docfx.json" />
<None Include="index.md" />
<None Include="packages.config" />
<None Include="toc.yml" />
</ItemGroup>
<ItemGroup>
<WCFMetadata Include="Connected Services\" />
@@ -154,4 +163,11 @@
</None>
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Import Project="..\packages\docfx.console.2.59.2\build\docfx.console.targets" Condition="Exists('..\packages\docfx.console.2.59.2\build\docfx.console.targets')" />
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
<PropertyGroup>
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
</PropertyGroup>
<Error Condition="!Exists('..\packages\docfx.console.2.59.2\build\docfx.console.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\docfx.console.2.59.2\build\docfx.console.targets'))" />
</Target>
</Project>
+68
View File
@@ -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"
]
}
}
+20
View File
@@ -0,0 +1,20 @@
# Icoel.Soap Library
Documentazione relativa alla libreria di interfaccia con il Sizer di ICOEL per le operazioni di R/W dei dati di batch di produzione
## Logica di funzionamento impianto ICOEL:
L'impianto Icoel prevede di comunicare in 3 modalita'':
1. OPC-UA per dati RealTime di processo/automazione
2. SOAP API per informazioni scambiate riguardo al setup dei batch da produrre (messa in coda) ed in produzione
3. DB per dati produttivita "nrear-realtime" e tracciatura
La presente libreria si occupa della modalità SOAP.
## Modalita'' impiego libreria
La libreria va chiamata inizializzando un oggetto Connector, e poi invocando i suoi metodi messia disposizione che si occupano di
- aprire canale di comunicazione
- effettuare chaimate
- chiudere canale
View File
+4
View File
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="docfx.console" version="2.59.2" targetFramework="net462" developmentDependency="true" />
</packages>
+6
View File
@@ -0,0 +1,6 @@
- name: Articles
href: articles/
- name: API Documentation
href: obj/api/
homepage: api/index.md