vendor/github.com/matoous/godox/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

GoDoX
===

[![Tests](https://github.com/matoous/godox/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/matoous/godox/actions) 
[![Lint](https://github.com/matoous/godox/workflows/.github/workflows/lint.yml/badge.svg)](https://github.com/matoous/godox/actions) 
[![GoDoc](https://godoc.org/github.com/matoous/godox?status.svg)](https://godoc.org/github.com/matoous/godox)
[![Go Report Card](https://goreportcard.com/badge/github.com/matoous/godox)](https://goreportcard.com/report/github.com/matoous/godox)
[![GitHub issues](https://img.shields.io/github/issues/matoous/godox.svg)](https://github.com/matoous/godox/issues)
[![License](https://img.shields.io/badge/license-MIT%20License-blue.svg)](https://github.com/matoous/godox/LICENSE)

GoDoX extracts comments from Go code based on keywords. This repository is fork of https://github.com/766b/godox
but a lot of code has changed, this repository is updated and the code was adjusted for better integration with 
https://github.com/golangci/golangci-lint.

Installation
---

    go get github.com/matoous/godox