Mono.Rocks.Tools.XmlDocs.Summary C# (CSharp) Method

Summary() public static method

public static Summary ( ) : IEnumerable
return IEnumerable
        public static IEnumerable<string> Summary(params object[] block)
        {
            return Block ("summary", null, block);
        }

Usage Example

Example #1
0
        void AddEqualsDocs(CodeTypeDeclaration type, CodeMemberMethod method, int n)
        {
            var et = XmlDocs.See(DefaultNamespace, type);

            method.Comments.AddDocs(
                XmlDocs.Param("obj",
                              "A " + et + "to compare this instance against."
                              ),
                XmlDocs.Summary(
                    "  Determines whether the current instance and the specified " + et + " have the same value."
                    ),
                XmlDocs.Returns(
                    "  <para>",
                    "   <see langword=\"true\"/> if each member of <paramref name=\"obj\"/>",
                    "   and the current instance have the same value (according to",
                    "   <see cref=\"M:System.Object.Equals(System.Object)\"/>); otherwise",
                    "   <see langword=\"false\"/> is returned.",
                    "  </para>"
                    ),
                XmlDocs.Remarks(
                    "  <para>",
                    "   This method checks for value equality",
                    "   (<see cref=\"M:System.Object.Equals(System.Object)\"/>), as defined by each",
                    "   value type.",
                    "  </para>"
                    )
                );
        }
All Usage Examples Of Mono.Rocks.Tools.XmlDocs::Summary