diff options
| author | Mike McQuaid | 2014-10-18 11:19:36 +0100 |
|---|---|---|
| committer | Mike McQuaid | 2014-10-18 11:19:36 +0100 |
| commit | 93c71bafca01fe14e01843572106eb9dcb909609 (patch) | |
| tree | a003e17745075b557fb71f81de974ae281475b0c /Library | |
| parent | 41cc28ca42e1bcaa9716d6c7930ec9c492ffa356 (diff) | |
| download | brew-93c71bafca01fe14e01843572106eb9dcb909609.tar.bz2 | |
Use YARD for API documentation.
Massive TODO.
We'll get there eventually...
Diffstat (limited to 'Library')
| -rw-r--r-- | Library/Homebrew/.rdoc_options | 17 | ||||
| -rw-r--r-- | Library/Homebrew/API.md | 4 |
2 files changed, 4 insertions, 17 deletions
diff --git a/Library/Homebrew/.rdoc_options b/Library/Homebrew/.rdoc_options deleted file mode 100644 index b953b9e3b..000000000 --- a/Library/Homebrew/.rdoc_options +++ /dev/null @@ -1,17 +0,0 @@ ---- !ruby/object:RDoc::Options -encoding: UTF-8 -static_path: [] -rdoc_include: -- . -charset: UTF-8 -exclude: -hyperlink_all: false -line_numbers: true -main_page: -markup: rdoc -page_dir: -show_hash: false -tab_width: 2 -title: Homebrew -visibility: :protected -webcvs: diff --git a/Library/Homebrew/API.md b/Library/Homebrew/API.md new file mode 100644 index 000000000..f154675e2 --- /dev/null +++ b/Library/Homebrew/API.md @@ -0,0 +1,4 @@ +# Homebrew Public API +We're (finally) working on a documented public API for Homebrew. It's currently a work in progress; a bunch of public stuff is documented and a bunch of private stuff is undocumented. Sorry about that! + +The main class you should look at is {Formula}. Assume everything else is private for now. |