shu/OnDoc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 20240719

Browse Source
This commit is contained in:
Stefan Hutter
2024-07-19 17:03:49 +02:00
parent 153fbef133
commit ea8d48ac9e
90 changed files with 1011 additions and 230 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
API_NetFramework/Areas/HelpPage/ApiDescriptionExtensions.cs
View File

@@ -3,7 +3,7 @@ using System.Text;
using System.Web;
using System.Web.Http.Description;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
public static class ApiDescriptionExtensions
{

4
API_NetFramework/Areas/HelpPage/App_Start/HelpPageConfig.cs
View File

@@ -16,7 +16,7 @@ using System.Web.Http;
using System.Web.Http.OData;
#endif
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// Use this class to customize the Help Page.
@@ -26,7 +26,7 @@ namespace EDOKAAPI_NetFramework.Areas.HelpPage
public static class HelpPageConfig
{
[SuppressMessage("Microsoft.Globalization", "CA1303:Do not pass literals as localized parameters",
MessageId = "EDOKAAPI_NetFramework.Areas.HelpPage.TextSample.#ctor(System.String)",
MessageId = "EDOKA API_NetFramework.Areas.HelpPage.TextSample.#ctor(System.String)",
Justification = "End users may choose to merge this string with existing localized resources.")]
[SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly",
MessageId = "bsonspec",

6
API_NetFramework/Areas/HelpPage/Controllers/HelpController.cs
View File

@@ -1,10 +1,10 @@
using System;
using System.Web.Http;
using System.Web.Mvc;
using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions;
using EDOKAAPI_NetFramework.Areas.HelpPage.Models;
using API_NetFramework.Areas.HelpPage.ModelDescriptions;
using API_NetFramework.Areas.HelpPage.Models;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.Controllers
namespace API_NetFramework.Areas.HelpPage.Controllers
{
/// <summary>
/// The controller that will handle requests for the help page.

2
API_NetFramework/Areas/HelpPage/HelpPageAreaRegistration.cs
View File

@@ -1,7 +1,7 @@
using System.Web.Http;
using System.Web.Mvc;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
public class HelpPageAreaRegistration : AreaRegistration
{

6
API_NetFramework/Areas/HelpPage/HelpPageConfigurationExtensions.cs
View File

@@ -11,10 +11,10 @@ using System.Net.Http.Headers;
using System.Web.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Description;
using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions;
using EDOKAAPI_NetFramework.Areas.HelpPage.Models;
using API_NetFramework.Areas.HelpPage.ModelDescriptions;
using API_NetFramework.Areas.HelpPage.Models;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
public static class HelpPageConfigurationExtensions
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/CollectionModelDescription.cs
View File

@@ -1,4 +1,4 @@
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class CollectionModelDescription : ModelDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ComplexTypeModelDescription.cs
View File

@@ -1,6 +1,6 @@
using System.Collections.ObjectModel;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class ComplexTypeModelDescription : ModelDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/DictionaryModelDescription.cs
View File

@@ -1,4 +1,4 @@
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class DictionaryModelDescription : KeyValuePairModelDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/EnumTypeModelDescription.cs
View File

@@ -1,7 +1,7 @@
using System.Collections.Generic;
using System.Collections.ObjectModel;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class EnumTypeModelDescription : ModelDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/EnumValueDescription.cs
View File

@@ -1,4 +1,4 @@
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class EnumValueDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/IModelDocumentationProvider.cs
View File

@@ -1,7 +1,7 @@
using System;
using System.Reflection;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public interface IModelDocumentationProvider
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/KeyValuePairModelDescription.cs
View File

@@ -1,4 +1,4 @@
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class KeyValuePairModelDescription : ModelDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ModelDescription.cs
View File

@@ -1,6 +1,6 @@
using System;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
/// <summary>
/// Describes a type model.

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ModelDescriptionGenerator.cs
View File

@@ -11,7 +11,7 @@ using System.Web.Http.Description;
using System.Xml.Serialization;
using Newtonsoft.Json;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
/// <summary>
/// Generates model descriptions for given types.

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ModelNameAttribute.cs
View File

@@ -1,6 +1,6 @@
using System;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
/// <summary>
/// Use this attribute to change the name of the <see cref="ModelDescription"/> generated for a type.

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ModelNameHelper.cs
View File

@@ -3,7 +3,7 @@ using System.Globalization;
using System.Linq;
using System.Reflection;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
internal static class ModelNameHelper
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ParameterAnnotation.cs
View File

@@ -1,6 +1,6 @@
using System;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class ParameterAnnotation
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/ParameterDescription.cs
View File

@@ -1,7 +1,7 @@
using System.Collections.Generic;
using System.Collections.ObjectModel;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class ParameterDescription
{

2
API_NetFramework/Areas/HelpPage/ModelDescriptions/SimpleTypeModelDescription.cs
View File

@@ -1,4 +1,4 @@
namespace EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
namespace API_NetFramework.Areas.HelpPage.ModelDescriptions
{
public class SimpleTypeModelDescription : ModelDescription
{

4
API_NetFramework/Areas/HelpPage/Models/HelpPageApiModel.cs
View File

@@ -2,9 +2,9 @@ using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Net.Http.Headers;
using System.Web.Http.Description;
using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions;
using API_NetFramework.Areas.HelpPage.ModelDescriptions;
namespace EDOKAAPI_NetFramework.Areas.HelpPage.Models
namespace API_NetFramework.Areas.HelpPage.Models
{
/// <summary>
/// The model that represents an API displayed on the help page.

2
API_NetFramework/Areas/HelpPage/SampleGeneration/HelpPageSampleGenerator.cs
View File

@@ -13,7 +13,7 @@ using System.Web.Http.Description;
using System.Xml.Linq;
using Newtonsoft.Json;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// This class will generate the samples for the help page.

2
API_NetFramework/Areas/HelpPage/SampleGeneration/HelpPageSampleKey.cs
View File

@@ -3,7 +3,7 @@ using System.Collections.Generic;
using System.ComponentModel;
using System.Net.Http.Headers;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// This is used to identify the place where the sample should be applied.

2
API_NetFramework/Areas/HelpPage/SampleGeneration/ImageSample.cs
View File

@@ -1,6 +1,6 @@
using System;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// This represents an image sample on the help page. There's a display template named ImageSample associated with this class.

2
API_NetFramework/Areas/HelpPage/SampleGeneration/InvalidSample.cs
View File

@@ -1,6 +1,6 @@
using System;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.

2
API_NetFramework/Areas/HelpPage/SampleGeneration/ObjectGenerator.cs
View File

@@ -6,7 +6,7 @@ using System.Globalization;
using System.Linq;
using System.Reflection;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// This class will create an object of a given type and populate it with sample data.

2
API_NetFramework/Areas/HelpPage/SampleGeneration/SampleDirection.cs
View File

@@ -1,4 +1,4 @@
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// Indicates whether the sample is used for request or response

2
API_NetFramework/Areas/HelpPage/SampleGeneration/TextSample.cs
View File

@@ -1,6 +1,6 @@
using System;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.

2
API_NetFramework/Areas/HelpPage/Views/Help/Api.cshtml
View File

@@ -1,5 +1,5 @@
@using System.Web.Http
@using EDOKAAPI_NetFramework.Areas.HelpPage.Models
@using API_NetFramework.Areas.HelpPage.Models
@model HelpPageApiModel
@{

4
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/ApiGroup.cshtml
View File

@@ -1,8 +1,8 @@
@using System.Web.Http
@using System.Web.Http.Controllers
@using System.Web.Http.Description
@using EDOKAAPI_NetFramework.Areas.HelpPage
@using EDOKAAPI_NetFramework.Areas.HelpPage.Models
@using API_NetFramework.Areas.HelpPage
@using API_NetFramework.Areas.HelpPage.Models
@model IGrouping<HttpControllerDescriptor, ApiDescription>
@{

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/CollectionModelDescription.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model CollectionModelDescription
@if (Model.ElementDescription is ComplexTypeModelDescription)
{

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/ComplexTypeModelDescription.cshtml
View File

@@ -1,3 +1,3 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model ComplexTypeModelDescription
@Html.DisplayFor(m => m.Properties, "Parameters")

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/DictionaryModelDescription.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model DictionaryModelDescription
Dictionary of @Html.DisplayFor(m => Model.KeyModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.KeyModelDescription }) [key]
and @Html.DisplayFor(m => Model.ValueModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ValueModelDescription }) [value]

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/EnumTypeModelDescription.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model EnumTypeModelDescription
<p>Possible enumeration values:</p>

4
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/HelpPageApiModel.cshtml
View File

@@ -1,7 +1,7 @@
@using System.Web.Http
@using System.Web.Http.Description
@using EDOKAAPI_NetFramework.Areas.HelpPage.Models
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.Models
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model HelpPageApiModel
@{

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/ImageSample.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage
@using API_NetFramework.Areas.HelpPage
@model ImageSample
<img src="@Model.Src" />

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/InvalidSample.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage
@using API_NetFramework.Areas.HelpPage
@model InvalidSample
@if (HttpContext.Current.IsDebuggingEnabled)

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/KeyValuePairModelDescription.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model KeyValuePairModelDescription
Pair of @Html.DisplayFor(m => Model.KeyModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.KeyModelDescription }) [key]
and @Html.DisplayFor(m => Model.ValueModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ValueModelDescription }) [value]

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/ModelDescriptionLink.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model Type
@{
ModelDescription modelDescription = ViewBag.modelDescription;

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml
View File

@@ -2,7 +2,7 @@
@using System.Collections.ObjectModel
@using System.Web.Http.Description
@using System.Threading
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model IList<ParameterDescription>
@if (Model.Count > 0)

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/SimpleTypeModelDescription.cshtml
View File

@@ -1,3 +1,3 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model SimpleTypeModelDescription
@Model.Documentation

2
API_NetFramework/Areas/HelpPage/Views/Help/DisplayTemplates/TextSample.cshtml
View File

@@ -1,4 +1,4 @@
@using EDOKAAPI_NetFramework.Areas.HelpPage
@using API_NetFramework.Areas.HelpPage
@model TextSample
<pre class="wrapped">

2
API_NetFramework/Areas/HelpPage/Views/Help/Index.cshtml
View File

@@ -2,7 +2,7 @@
@using System.Web.Http.Controllers
@using System.Web.Http.Description
@using System.Collections.ObjectModel
@using EDOKAAPI_NetFramework.Areas.HelpPage.Models
@using API_NetFramework.Areas.HelpPage.Models
@model Collection<ApiDescription>
@{

2
API_NetFramework/Areas/HelpPage/Views/Help/ResourceModel.cshtml
View File

@@ -1,5 +1,5 @@
@using System.Web.Http
@using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions
@using API_NetFramework.Areas.HelpPage.ModelDescriptions
@model ModelDescription
<link type="text/css" href="~/Areas/HelpPage/HelpPage.css" rel="stylesheet" />

4
API_NetFramework/Areas/HelpPage/XmlDocumentationProvider.cs
View File

@@ -5,9 +5,9 @@ using System.Reflection;
using System.Web.Http.Controllers;
using System.Web.Http.Description;
using System.Xml.XPath;
using EDOKAAPI_NetFramework.Areas.HelpPage.ModelDescriptions;
using API_NetFramework.Areas.HelpPage.ModelDescriptions;
namespace EDOKAAPI_NetFramework.Areas.HelpPage
namespace API_NetFramework.Areas.HelpPage
{
/// <summary>
/// A custom <see cref="IDocumentationProvider"/> that reads the API documentation from an XML documentation file.