From 93c71bafca01fe14e01843572106eb9dcb909609 Mon Sep 17 00:00:00 2001
From: Mike McQuaid
Date: Sat, 18 Oct 2014 11:19:36 +0100
Subject: Use YARD for API documentation.

Massive TODO.

We'll get there eventually...
---
 Library/Homebrew/.rdoc_options | 17 -----------------
 Library/Homebrew/API.md        |  4 ++++
 2 files changed, 4 insertions(+), 17 deletions(-)
 delete mode 100644 Library/Homebrew/.rdoc_options
 create mode 100644 Library/Homebrew/API.md

(limited to 'Library')

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.
-- 
cgit v1.2.3