# generate documentation

Published articles for generate documentation.

This is one page of public article previews, not the complete archive. Follow Next page to continue. Summaries are not the original full articles.

## Writing testable examples in Go

DevFeed: [Writing testable examples in Go](<https://devfeed.tech/articles/writing-testable-examples-in-go-22211.md>)

Original publisher: [Read original article](<https://www.ardanlabs.com/blog/2023/01/writing-testable-examples-in-go.html>)

Published: 2023-01-12T00:00:00Z

Content type: tutorial

Language: en

Sources: [William Kennedy](<https://devfeed.tech/sources/william-kennedy.md>)

Topics: [Go Language](<https://devfeed.tech/topics/go-language.md>), [Documentation](<https://devfeed.tech/topics/documentation.md>), [Code](<https://devfeed.tech/topics/code.md>), [test](<https://devfeed.tech/topics/test.md>)

Tags: [code-comments](<https://devfeed.tech/tags/code-comments.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [examples](<https://devfeed.tech/tags/examples.md>), [generate-documentation](<https://devfeed.tech/tags/generate-documentation.md>), [go](<https://devfeed.tech/tags/go.md>), [golang](<https://devfeed.tech/tags/golang.md>), [syntax](<https://devfeed.tech/tags/syntax.md>), [test](<https://devfeed.tech/tags/test.md>), [testable-examples](<https://devfeed.tech/tags/testable-examples.md>), [toolchain](<https://devfeed.tech/tags/toolchain.md>)

### AI overview

This video tutorial explains how to write testable examples in Go documentation. It covers Go's documentation comments, special comment syntax for formatting, and test functions that produce code samples users can run.

### Source excerpt

Introduction Google developed Go to be an alternative to C++ with the internet and scale in mind. Go's toolchain automates tasks that are easily overlooked, and amongst those tasks is generating documentation. Go has the ability to generate documentation based on comments written in your source code. As the end user, you have the choice to view this documentation in your terminal or, if your code is publicly accessible, on pkg.go.dev. Go also offers special comment syntax to further format and style the generated documentation.

## Kdoc for Android libraries using Dokka

DevFeed: [Kdoc for Android libraries using Dokka](<https://devfeed.tech/articles/kdoc-for-android-libraries-using-dokka-28689.md>)

Original publisher: [Read original article](<https://jeroenmols.com/blog/2020/02/19/dokka-code-documentation/>)

Author: info@jeroenmols.com (Jeroen Mols)

Published: 2020-02-19T00:00:00Z

Content type: tutorial

Language: en

Sources: [Jeroen Mols](<https://devfeed.tech/sources/jeroen-mols.md>)

Topics: [Documentation](<https://devfeed.tech/topics/documentation.md>), [generate documentation](<https://devfeed.tech/topics/generate-documentation.md>), [Kotlin](<https://devfeed.tech/topics/kotlin.md>), [Library](<https://devfeed.tech/topics/library.md>), [modules](<https://devfeed.tech/topics/modules.md>), [Gradle](<https://devfeed.tech/topics/gradle.md>), [Submodules](<https://devfeed.tech/topics/submodules.md>), [GitHub Pages](<https://devfeed.tech/topics/github-pages.md>)

Tags: [blogs](<https://devfeed.tech/tags/blogs.md>), [documentation](<https://devfeed.tech/tags/documentation.md>), [dokka](<https://devfeed.tech/tags/dokka.md>), [generate-documentation](<https://devfeed.tech/tags/generate-documentation.md>), [github-pages](<https://devfeed.tech/tags/github-pages.md>), [gradle](<https://devfeed.tech/tags/gradle.md>), [kdoc](<https://devfeed.tech/tags/kdoc.md>), [kotlin](<https://devfeed.tech/tags/kotlin.md>), [library](<https://devfeed.tech/tags/library.md>), [module](<https://devfeed.tech/tags/module.md>), [submodules](<https://devfeed.tech/tags/submodules.md>)

### AI overview

This tutorial explains how to generate KDoc for Kotlin libraries with the Dokka Gradle plugin. It covers basic configuration, output formats, and challenges involving multi-module libraries, submodule sources, and API visibility.

### Source excerpt

A great way to make your library easier to use it to generate code documentation for its public interface. The default way to do this in Kotlin is to generate KDoc using the official Dokka plugin.