C# (CSharp) TypeDocumentationCreator Exemples

Exemple #1

        public void TestPropertyLink2()
        {
            var doc    = new TypeDocumentationCreator <TypeWithPropertyLinks>();
            var result = Render(doc);

            result.Should().Contain("I'm related to AnotherProperty.");
        }

Exemple #2

        public void TestFieldLink()
        {
            var doc    = new TypeDocumentationCreator <TypeWithFieldLinks>();
            var result = Render(doc);

            result.Should().Contain("I have a property SomeField.");
        }

Exemple #3

        public void TestObject()
        {
            var doc    = new TypeDocumentationCreator <object>();
            var result = Render(doc);

            result.Should().Contain("Inheritance Object\r\n");
        }

Exemple #4

        public void TestInheritingType()
        {
            var doc    = new TypeDocumentationCreator <InheritingType>();
            var result = Render(doc);

            result.Should().Contain("Inheritance Object -> PublicAbstractType -> InheritingType");
        }

Exemple #5

        public void TestTypeWithSerializableAttribute()
        {
            var doc    = new TypeDocumentationCreator <TypeWithSerializableAttribute>();
            var result = Render(doc);

            result.Should().Contain("[System.Serializable]");
        }

Exemple #6

        public void TestPublicType()
        {
            var doc    = new TypeDocumentationCreator <PublicType>();
            var result = Render(doc);

            result.Should().Contain("public class PublicType : System.Object");
        }

Exemple #7

        public void TestEnum()
        {
            var doc    = new TypeDocumentationCreator <AnEnum>();
            var result = Render(doc);

            result.Should().Contain("public enum AnEnum : System.Enum");
        }

Exemple #8

        public void TestNamespace()
        {
            var doc    = new TypeDocumentationCreator <SomeType>();
            var result = Render(doc);

            result.Should().Contain("Namespace");
            result.Should().Contain("dotnetdoc.TestTypes.SomeFolder");
        }

Exemple #9

        public void TestDocumentTypeWithSee()
        {
            var doc    = new TypeDocumentationCreator <TypeWithSee>();
            var result = Render(doc);

            result.Should().Contain("This class is similar to dotnetdoc.TestTypes.EmptyType");
            result.Should().Contain("Related to System.Double.");
        }

Exemple #10

        public void TestAssembly()
        {
            var doc    = new TypeDocumentationCreator <SomeType>();
            var result = Render(doc);

            result.Should().Contain("Assembly");
            result.Should().Contain("dotnetdoc.TestTypes");
            result.Should().Contain("dotnetdoc.TestTypes.dll");
        }

Exemple #11

        public void TestDocumentEmptyType()
        {
            var doc = new TypeDocumentationCreator <EmptyType>();

            Render(doc).Should().Contain("EmptyType");
        }