@@ -0,0 +1,30 @@
|
||||
using System;
|
||||
|
||||
namespace ExampleLibrary
|
||||
{
|
||||
/// <summary>
|
||||
/// Marks the model as documentation example to be exported by the ExampleGenerator program.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class DocumentationExampleAttribute : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
///
|
||||
/// </summary>
|
||||
/// <param name="filename">The filename of the documentation file without extension. For sub folders, use '/' as path delimiter.</param>
|
||||
public DocumentationExampleAttribute(string filename)
|
||||
{
|
||||
this.Filename = filename;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the filename.
|
||||
/// </summary>
|
||||
/// <value>The filename.</value>
|
||||
/// <remarks>
|
||||
/// For sub folders, use '/' as path delimiter.
|
||||
/// This is then replaced with the current platforms path separator later in the process.
|
||||
/// </remarks>
|
||||
public string Filename { get; private set; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
// <copyright file="ExampleAttribute.cs" company="OxyPlot">
|
||||
// Copyright (c) 2014 OxyPlot contributors
|
||||
// </copyright>
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
namespace ExampleLibrary
|
||||
{
|
||||
using System;
|
||||
|
||||
/// <summary>
|
||||
/// Specifies the title for an example.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Method)]
|
||||
public class ExampleAttribute : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ExampleAttribute"/> class.
|
||||
/// </summary>
|
||||
/// <param name="title">The title.</param>
|
||||
/// <param name="excludeFromAutomatedTests">A value indiciating whether the example should be excluded from automated tests.</param>
|
||||
public ExampleAttribute(string title = null, bool excludeFromAutomatedTests = false)
|
||||
{
|
||||
this.Title = title;
|
||||
this.ExcludeFromAutomatedTests = excludeFromAutomatedTests;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the title.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// The title.
|
||||
/// </value>
|
||||
public string Title { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indiciating whether this example should be excluded from automated tests.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// <c>true</c> if the example should be excluded from automated tests, otherwise <c>false</c>.
|
||||
/// </value>
|
||||
public bool ExcludeFromAutomatedTests { get; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
// <copyright file="ExamplesAttribute.cs" company="OxyPlot">
|
||||
// Copyright (c) 2014 OxyPlot contributors
|
||||
// </copyright>
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
namespace ExampleLibrary
|
||||
{
|
||||
using System;
|
||||
|
||||
/// <summary>
|
||||
/// Specifies the category for a class containing examples.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class)]
|
||||
public class ExamplesAttribute : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="ExamplesAttribute"/> class.
|
||||
/// </summary>
|
||||
/// <param name="category">The category.</param>
|
||||
public ExamplesAttribute(string category = null)
|
||||
{
|
||||
this.Category = category;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the category.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// The category.
|
||||
/// </value>
|
||||
public string Category { get; private set; }
|
||||
}
|
||||
}
|
||||
34
Source/Examples/ExampleLibrary/Attributes/TagsAttribute.cs
Normal file
34
Source/Examples/ExampleLibrary/Attributes/TagsAttribute.cs
Normal file
@@ -0,0 +1,34 @@
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
// <copyright file="TagsAttribute.cs" company="OxyPlot">
|
||||
// Copyright (c) 2014 OxyPlot contributors
|
||||
// </copyright>
|
||||
// --------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
namespace ExampleLibrary
|
||||
{
|
||||
using System;
|
||||
|
||||
/// <summary>
|
||||
/// Specifies tags.
|
||||
/// </summary>
|
||||
[AttributeUsage(AttributeTargets.Class)]
|
||||
public class TagsAttribute : Attribute
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="TagsAttribute" /> class.
|
||||
/// </summary>
|
||||
/// <param name="tags">The tags.</param>
|
||||
public TagsAttribute(params string[] tags)
|
||||
{
|
||||
this.Tags = tags;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the tags.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// The tags.
|
||||
/// </value>
|
||||
public string[] Tags { get; private set; }
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user