private DocumentViewTypeViewModel BuildMethodViewModel(DocumentViewTypeViewModel model, Document selected, string name)
{
DocumentMethod method = selected.Methods.Where(f => HtmlHelper.RouteFriendlyName(f.MethodName) == name).FirstOrDefault();
if (method == null)
return null;
model.TypeName = $"{ReturnUptoParam(method.MethodName)} Method";
model.Returns = method.Returns;
model.ShortDescription = method.ShortDescription;
model.LongDescription = method.LongDescription;
model.Summary = method.Summary;
model.ExampleUseage = method.ExampleUseage ?? String.Empty;
model.Parameters = method.Parameters;
foreach (DocumentExample item in method.Examples)
{
model.ExampleUseage += $"<p>{item.Text}</p>";
}
foreach (DocumentException exception in method.Exception)
{
model.Exceptions += $"<p>{exception.ExceptionName}<br />{exception.Summary}";
}
model.Remarks = method.Remarks;
return model;
}
public static string GetDocMethod(DocumentMethod method)
{
if (DocMethods.ContainsKey(method))
return DocMethods[method];
return null;
}
private DocumentViewTypeViewModel BuildConstructorViewModel(DocumentViewTypeViewModel model, Document selected, string name)
{
DocumentMethod constructor = selected.Constructors.Where(f => HtmlHelper.RouteFriendlyName(f.MethodName) == name).FirstOrDefault();
if (constructor == null)
return null;
model.TypeName = $"{ReturnUptoParam(constructor.MethodName)} Constructor";
model.Returns = constructor.Returns;
model.ShortDescription = constructor.ShortDescription;
model.LongDescription = constructor.LongDescription;
model.Summary = constructor.Summary;
model.ExampleUseage = constructor.ExampleUseage;
model.Parameters = constructor.Parameters;
foreach (DocumentExample item in constructor.Examples)
{
model.ExampleUseage += $"<p>{item.Text}</p>";
}
foreach (DocumentException exception in constructor.Exception)
{
model.Exceptions += $"<p>{exception.ExceptionName}<br />{exception.Summary}";
}
model.Remarks = constructor.Remarks;
return model;
}
private DocumentViewTypeViewModel BuildMethodViewModel(DocumentViewTypeViewModel model, Document selected, string name)
{
DocumentMethod method = selected.Methods.Where(f => HtmlHelper.RouteFriendlyName(f.MethodName) == name).FirstOrDefault();
if (method == null)
{
return(null);
}
model.TypeName = $"{ReturnUptoParam(method.MethodName)} Method";
model.Returns = method.Returns;
model.ShortDescription = method.ShortDescription;
model.LongDescription = method.LongDescription;
model.Summary = method.Summary;
model.ExampleUseage = method.ExampleUseage;
model.Parameters = method.Parameters;
return(model);
}
private DocumentViewTypeViewModel BuildConstructorViewModel(DocumentViewTypeViewModel model, Document selected, string name)
{
DocumentMethod constructor = selected.Constructors.Where(f => HtmlHelper.RouteFriendlyName(f.MethodName) == name).FirstOrDefault();
if (constructor == null)
{
return(null);
}
model.TypeName = $"{ReturnUptoParam(constructor.MethodName)} Constructor";
model.Returns = constructor.Returns;
model.ShortDescription = constructor.ShortDescription;
model.LongDescription = constructor.LongDescription;
model.Summary = constructor.Summary;
model.ExampleUseage = constructor.ExampleUseage;
model.Parameters = constructor.Parameters;
return(model);
}
public void TestSplitConstructorNameWithCurlyBracesRemoveNamespaceConvertBraces()
{
List <Document> documents = new List <Document>();
documents.Add(new Document(Shared.DocumentType.Class, "Test", "Test", "ClassName", "T:Middleware.Blog.BlogItem"));
DocumentMethod documentConstructor = new DocumentMethod(Shared.DocumentType.Constructor, "Test", "Test", "Test",
"M:Middleware.Blog.BlogItem.#ctor(System.Collections.Generic.List{Middleware.Blog.BlogComment}@)",
"M:Blog.Plugin.Classes.BlogSitemapProvider.Items");
documents[0].Constructors.Add(documentConstructor);
DocumentPostProcess postProcess = new DocumentPostProcess(documents);
postProcess.Process();
Assert.IsNotNull(postProcess);
Assert.AreEqual("M:Middleware.Blog.BlogItem.#ctor(List<BlogComment>@)", documents[0].Constructors[0].MethodName);
}
public void TestSplitConstructorValueRemoveNamespace()
{
List <Document> documents = new List <Document>();
documents.Add(new Document(Shared.DocumentType.Class, "Test", "Test", "ClassName", "T:Test.ClassName"));
DocumentMethod documentMethod = new DocumentMethod(Shared.DocumentType.Method, "Test", "Test", "Test", "#ctor(Some.NameSpace.Class)", "M:Blog.Plugin.Classes.BlogSitemapProvider.Items");
documentMethod.Returns = "List<Some.Namespace.Name.ISitemapItem>";
documents[0].Methods.Add(documentMethod);
DocumentPostProcess postProcess = new DocumentPostProcess(documents);
postProcess.Process();
Assert.IsNotNull(postProcess);
Assert.AreEqual("#ctor(Class)", documents[0].Methods[0].MethodName);
Assert.AreEqual("List<ISitemapItem>", documents[0].Methods[0].Returns);
}
/// <summary>
///
/// </summary>
/// <param name="method"></param>
/// <returns></returns>
public IWebHttpRequest MethodAs(DocumentMethod method)
{
string val = CouchConstant.GetDocMethod(method);
if (val == null)
throw new CouchException("The given method is not managed, value: " + method);
this.customRequest.Method = val;
return this;
}
