brew/Library/Homebrew/README.md

# Homebrew Ruby API

This is the API for [Homebrew](https://github.com/Homebrew).

The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.

You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://rubystyle.guide) helpful in creating formulae.

Good luck!
Move YARD config into `Library/Homebrew`. 2021-03-30 04:38:45 +02:00			`# Homebrew Ruby API`
Generate and push rubydoc.brew.sh This is a replacement for the rubydoc.info site that has been a bit unreliable for us. Also, note we're using the community Ruby style guide now rather than the GitHub one. 2019-03-28 21:15:50 +00:00
Adjust YARD config. 2021-04-03 02:09:22 +02:00			`This is the API for [Homebrew](https://github.com/Homebrew).`
Use YARD for API documentation. Massive TODO. We'll get there eventually... 2014-10-18 11:19:36 +01:00
More API documentation. And remove the documented stuff from the `example-formula.rb`. Closes Homebrew/homebrew#43241. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com> 2015-08-29 10:56:24 +01:00			`The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.`

apidoc: update URLs 2020-11-03 12:39:26 -05:00			`You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://rubystyle.guide) helpful in creating formulae.`
More API documentation. And remove the documented stuff from the `example-formula.rb`. Closes Homebrew/homebrew#43241. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com> 2015-08-29 10:56:24 +01:00
			`Good luck!`