search

Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
160 stars 26 forks source link

Add support for excluding specific type, property, method, etc.. #29

Closed petarpetrovt closed 4 years ago

petarpetrovt commented 4 years ago

Possible tag <exclude/> similar to NDoc and Sandcastle - stackoverflow.

Example:

#if NETSTANDARD1_3
namespace System.Diagnostics.CodeAnalysis
{
    /// <exclude/>
    [AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Event, Inherited = false, AllowMultiple = false)]
    internal sealed class ExcludeFromCodeCoverageAttribute : Attribute
    {
        /// <summary>
        /// Gets or sets the justification for excluding the member from code coverage.
        /// </summary>
        public string? Justification { get; set; }
    }
}
#endif

Should skip ExcludeFromCodeCoverageAttribute and don't generate documentation for System.Diagnostics.CodeAnalysis namespace.

petarpetrovt commented 4 years ago

Awesome! Thanks!

petarpetrovt commented 4 years ago

@Doraku When do you plan to release v0.6.13 NuGet package ?

Doraku commented 4 years ago

This is kinda embarrassing, I wanted to do it yesterday but for some reason nuget.org is now refusing the MIT-0 license while I had no problem previously ^^" I opened an issue and await a resolution but if nothing comes up in the next couple of days I guess I will revert back to MIT to push this release.