Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Kodiak

A collection of wrappers around various code documentation tools which produces a common JSON output readable by Orchid.

GitHub release (latest by date) Maven Central Kotlin Version

Supported Platforms/Features

Target Language Documentation Tool
Java Javadoc
Kotlin Dokka
Groovy Groovydoc
Swift SourceKitten

Installation

repositories {
    mavenCentral()
}

// for plain JVM or Android projects
dependencies {
    implementation("io.github.copper-leaf:kodiak-core:{{site.version}}")
}

// for multiplatform projects
kotlin {
    sourceSets {
        val commonMain by getting {
            dependencies {
                implementation("io.github.copper-leaf:kodiak-core:{{site.version}}")
            }
        }
    }
}

Documentation

See the website for detailed documentation and usage instructions.

License

kodiak is licensed under the BSD 3-Clause License, see LICENSE.md.

References

About

Wrappers around code documentation CLI tools to produce JSON models, usable as libraries

Resources

License

Stars

Watchers

Forks

Packages

No packages published