diff --git a/Library/Homebrew/.yardopts b/Library/Homebrew/.yardopts index b9707ac3dc..b86f778054 100644 --- a/Library/Homebrew/.yardopts +++ b/Library/Homebrew/.yardopts @@ -7,6 +7,7 @@ --exclude test/ --exclude vendor/ --exclude compat/ +extend/os/**/*.rb **/*.rb - *.md diff --git a/Library/Homebrew/README.md b/Library/Homebrew/README.md index fb78ab260a..7f6b9bbf55 100644 --- a/Library/Homebrew/README.md +++ b/Library/Homebrew/README.md @@ -1,6 +1,6 @@ # Homebrew Ruby API -This is the public API for [Homebrew](https://github.com/Homebrew). +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. diff --git a/Library/Homebrew/yard/templates/default/docstring/html/internal.erb b/Library/Homebrew/yard/templates/default/docstring/html/internal.erb index 569a4bf427..e5585e7dfa 100644 --- a/Library/Homebrew/yard/templates/default/docstring/html/internal.erb +++ b/Library/Homebrew/yard/templates/default/docstring/html/internal.erb @@ -1,5 +1,5 @@
This <%= object.type %> is part of an internal API. This <%= object.type %> may only be used internally in repositories owned by Homebrew, except in casks or formulae. - Third parties should avoid using this <%= object.type %> if possible, as it may be removed or be changed without warning. + Third parties should avoid using this <%= object.type %> if possible, as it may be removed or changed without warning.
diff --git a/Library/Homebrew/yard/templates/default/docstring/html/private.erb b/Library/Homebrew/yard/templates/default/docstring/html/private.erb index e38e105dc5..611579f1ed 100644 --- a/Library/Homebrew/yard/templates/default/docstring/html/private.erb +++ b/Library/Homebrew/yard/templates/default/docstring/html/private.erb @@ -1,5 +1,5 @@This <%= object.type %> is part of a private API. This <%= object.type %> may only be used in the Homebrew/brew repository. - Third parties should avoid using this <%= object.type %> if possible, as it may be removed or be changed without warning. + Third parties should avoid using this <%= object.type %> if possible, as it may be removed or changed without warning.
diff --git a/Library/Homebrew/yard/templates/default/layout/html/footer.erb b/Library/Homebrew/yard/templates/default/layout/html/footer.erb new file mode 100644 index 0000000000..a3d08fca95 --- /dev/null +++ b/Library/Homebrew/yard/templates/default/layout/html/footer.erb @@ -0,0 +1,3 @@ +