Skip to content

Instantly share code, notes, and snippets.

@m2wasabi
Last active August 29, 2015 14:08
Show Gist options
  • Save m2wasabi/9b542430f5217a159a78 to your computer and use it in GitHub Desktop.
Save m2wasabi/9b542430f5217a159a78 to your computer and use it in GitHub Desktop.
API Reference template

HOGE API Reference

CLASS1_NAME

Function Description
function1 description hogehoge
function2 description hogehoge
function3 description hogehoge
function4 description hogehoge

class1.function1()

description hogehoge

params
function1(param1, [param2], ...)
param1
param1 is a dog
param2
param1 is a cats and followers **hoge**

Memo: hogehoge

sample
function1(param1, callback)
param1
param1 is a dog
callback(return, error)
param1 is a cats and followers **hoge**
sample
return

Object Class2: some result of function1.hogehoge

usage sample
var app = new Class();
app.method();

CLASS2_NAME

TODO:fill class definition


FUGA API

CLASS_NAME

TODO:fill class definition

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment