Skip to content

dotnetaddicted/cake-apireference-uploader

Repository files navigation

Cake ApiReference Uploader

CakeBuild extension for uploading Api references to specified URL

How to upload ApiReference for .NET (DLL + XML)

UploadApiReferences(
    new RestApiCredentials {
        UserName = "username", 
        Password = "password", 
        Uri = "https://api.domain.com/v1/GenerateApiReferenceDotNet"
    },
    new DotNetOptions {
        ProductKey = "productKey",
        DllFilePath = "C:\SomeProduct.dll",
        XmlFilePath = "C:\SomeProduct.xml"
    });  

How to upload ApiReference for .NET (HTML Help generated by SandCastle SHFB)

UploadApiReferences(
    new RestApiCredentials {
        UserName = "username", 
        Password = "password", 
        Uri = "https://api.domain.com/v1/GenerateDotNetHtmlApiRef"
    },
    new DotNetHtmlOptions {
        ProductKey = "productKey",
        ZipFilePath = "C:\SomeProduct.zip",
    });  

How to upload ApiReference for Java

UploadApiReferences(
    new RestApiCredentials {
        UserName = "username", 
        Password = "password", 
        Uri = "https://api.domain.com/v1/GenerateApiReferenceJava"
    },
    new JavaOptions {
        ProductKey = "productKey",
        Version = "18.8",
        JarFilePath  = "C:\SomeProduct.javadoc"
    });   

About

CakeBuild extension for uploading Api references to specified URL

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages