From 51fd596cd2898e43ea45230b338250cd34f5fca0 Mon Sep 17 00:00:00 2001
From: Mike McQuaid
Date: Sun, 26 Oct 2014 15:42:41 +0000
Subject: Improve API documentation output.

And include more files.---
 .yardopts                          | 4 +++-
 Library/Homebrew/API.md            | 4 ----
 Library/Homebrew/README.md         | 4 ++++
 Library/Homebrew/os/mac/xquartz.rb | 4 ++--
 4 files changed, 9 insertions(+), 7 deletions(-)
 delete mode 100644 Library/Homebrew/API.md
 create mode 100644 Library/Homebrew/README.md

diff --git a/.yardopts b/.yardopts
index aead7677f..821b67c36 100644
--- a/.yardopts
+++ b/.yardopts
@@ -1,8 +1,10 @@
 --title "Homebrew"
---main Library/Homebrew/API.md
+--main Library/Homebrew/README.md
 --exclude Library/Homebrew/test/vendor/
 --exclude Library/Homebrew/vendor/
 Library/Homebrew/**/*.rb
 -
 Library/Homebrew/*.md
+Library/Homebrew/manpages/*.md
+share/doc/homebrew/*.md
 *.md
diff --git a/Library/Homebrew/API.md b/Library/Homebrew/API.md
deleted file mode 100644
index f154675e2..000000000
--- a/Library/Homebrew/API.md
+++ /dev/null
@@ -1,4 +0,0 @@
-# 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.
diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md
new file mode 100644
index 000000000..f154675e2
--- /dev/null
+++ b/Library/Homebrew/README.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.
diff --git a/Library/Homebrew/os/mac/xquartz.rb b/Library/Homebrew/os/mac/xquartz.rb
index 439c1b4db..79b50df44 100644
--- a/Library/Homebrew/os/mac/xquartz.rb
+++ b/Library/Homebrew/os/mac/xquartz.rb
@@ -90,8 +90,8 @@ module OS
       end
 
       # This should really be private, but for compatibility reasons it must
-      # remain public. New code should use MacOS::X11.{bin,lib,include}
-      # instead, as that accounts for Xcode-only systems.
+      # remain public. New code should use MacOS::X11.bin, MacOS::X11.lib and
+      # MacOS::X11.include instead, as that accounts for Xcode-only systems.
       def prefix
         @prefix ||= if Pathname.new('/opt/X11/lib/libpng.dylib').exist?
           Pathname.new('/opt/X11')
-- 
cgit v1.2.3