Skip to content
/ creDoc Public

program that generates a markdown file from go file comments

License

Notifications You must be signed in to change notification settings

prr123/creDoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

creDoc

documentation for golang credoc parses a go file for top comments, types, functions and methods. The file description is expected to consist of comments before the package statement.

Descriptions of types, functions and methods are expected to be comments after the definition.

Installation

compile file add alias in .bashrc

Description

detailed description can be found in credoc.md

About

program that generates a markdown file from go file comments

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages