GithubHelp home page GithubHelp logo

shedoc's Introduction

Shedoc

Shedoc is a documentation standard and supporting tooling for shell scripts.

Documenting Scripts

#?/synopsis
#?/summary
#?/index

#?/description

#?/synopsis

#?/summary

#?/index

#?/description

Documenting Functions

Functions can take advantage of shedoc docblocks. Following a similar pattern used in other languages, it provides a formal syntax for documenting a function's ins, outs, and behavior.

##
 # [description]
 #
 # @env
 #
 # @arg
 # @switch
 #
 # @stdin
 # @stdout
 # @stderr
 #
 # @return
##
 # Links all specified packages that are found in the target package's
 # dependency list.
 #
 # @env      ENV_VARIABLE an environment variable used by the function
 #
 # @arg      the target package containing dependencies to be linked
 # @arg      array   the array of dependencies to be linked, if present
 # @switch   [-a, --all]
 #
 # @stdin
 # @stdout
 # @stderr
 #
 # @exit     0   on success
 # @exit     1   if the target package cannot be found
 # @exit     2   if one or more of the matching dependencies could not be linked
 #

@env

@arg

@param

@switch

@stdin

@stdout

@stderr

@exit

Tools

Doc

shedoc's People

Contributors

rogwilco avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.