https://github.com/copper-leaf/kodiak

Wrappers around code documentation CLI tools to produce JSON models, usable as libraries
https://github.com/copper-leaf/kodiak

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/copper-leaf/kodiak
• Owner: copper-leaf
• License: bsd-3-clause
• Created: 2018-08-28T00:52:37.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-22T17:10:06.000Z (about 5 years ago)
• Last Synced: 2025-04-11T21:21:58.012Z (about 1 year ago)
• Language: Kotlin
• Homepage: https://copper-leaf.github.io/kodiak
• Size: 186 MB
• Stars: 16
• Watchers: 1
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Kodiak

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

![GitHub release (latest by date)](https://img.shields.io/github/v/release/copper-leaf/kodiak)

![Maven Central](https://img.shields.io/maven-central/v/io.github.copper-leaf/kodiak-core)

![Kotlin Version](https://img.shields.io/badge/Kotlin-1.4.32-orange)

# Supported Platforms/Features

| Target Language | Documentation Tool |

| --------------- | ------------------ |

| Java            | Javadoc            |

| Kotlin          | Dokka              |

| Groovy          | Groovydoc          |

| Swift           | SourceKitten       |

# Installation

```kotlin

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](https://copper-leaf.github.io/kodiak/) for detailed documentation and usage instructions.

# License 

kodiak is licensed under the BSD 3-Clause License, see [LICENSE.md](https://github.com/copper-leaf/kodiak/tree/master/LICENSE.md). 

# References

- [SRML](https://github.com/jasonwyatt/SRML)