Markdown.Generator.Core - smarthead/markdown-generator GitHub Wiki

Beautifier

public static class Markdown.Generator.Core.Beautifier

Static Methods

Type Name Summary
String BeautifyType(Type t, Boolean isFull = False)
String ToMarkdownMethodInfo(MethodInfo methodInfo)

MarkdownableType

public class Markdown.Generator.Core.MarkdownableType

Properties

Type Name Summary
String BeautifyName
String Name
String Namespace

Methods

Type Name Summary
EventInfo[] GetEvents()
FieldInfo[] GetFields()
MethodInfo[] GetMethods()
PropertyInfo[] GetProperties()
EventInfo[] GetStaticEvents()
MethodInfo[] GetStaticMethods()
PropertyInfo[] GetStaticProperties()
String ToString()

MarkdownBuilder

public class Markdown.Generator.Core.MarkdownBuilder

Properties

Type Name Summary
IEnumerable<ElementBase> Elements

Methods

Type Name Summary
void Append(String text)
void AppendLine(String text = null)
void Code(String language, String code)
void CodeQuote(String code)
void Header(Int32 level, String text)
void HeaderWithCode(Int32 level, String code)
void HeaderWithLink(Int32 level, String text, String url)
void Image(String altText, String imageUrl)
void Link(String text, String url)
void List(String text)
void ListLink(String text, String url)
void Table(String[] headers, IEnumerable<String[]> items)
String ToString()

Static Methods

Type Name Summary
String MarkdownCodeQuote(String code)

MarkdownGenerator

public static class Markdown.Generator.Core.MarkdownGenerator

Static Methods

Type Name Summary
MarkdownableType[] Load(String dllPath, String namespaceMatch)
MarkdownableType[] Load(Assembly[] assemblies, String namespaceMatch)
MarkdownableType[] Load(Type[] types)

MemberType

public enum Markdown.Generator.Core.MemberType
    : Enum, IComparable, IFormattable, IConvertible

Enum

Value Name Summary
0 None
69 Event
70 Field
77 Method
80 Property
84 Type

VsDocParser

public static class Markdown.Generator.Core.VsDocParser

Static Methods

Type Name Summary
XmlDocumentComment[] ParseXmlComment(XDocument xDocument)
XmlDocumentComment[] ParseXmlComment(XDocument xDocument, String namespaceMatch)

XmlDocumentComment

public class Markdown.Generator.Core.XmlDocumentComment

Properties

Type Name Summary
String ClassName
String MemberName
MemberType MemberType
Dictionary<String, String> Parameters
String Remarks
String Returns
String Summary

Methods

Type Name Summary
String ToString()
⚠️ **GitHub.com Fallback** ⚠️