Giter Club home page Giter Club logo

autohelp's Introduction

Erlang autohelp parse_transform

This parse_transform makes your code self-descriptive. When you add @doc annotation for module or function, it goes to EDoc's output. With autohelp you can view it using Module:help functions:

  • Module:help() shows module description and list of functions with names of arguments
  • Module:help(FunctionName) shows brief description for functions with given name and all arities
  • Module:help(FunctionName, Arity) shows full function description

All output goes to stdout (it is designed to look well in shell), return values are ok.

Usage

Just add compile option to your code:

-compile({parse_transform, autohelp}).

After that functions help/0, help/1, help/2 will be added to your module.

autohelp's People

Contributors

stolen avatar

Watchers

James Cloos 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.