mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
Adjust YARD config.
This commit is contained in:
parent
0e71efb131
commit
695d44847a
@ -7,6 +7,7 @@
|
||||
--exclude test/
|
||||
--exclude vendor/
|
||||
--exclude compat/
|
||||
extend/os/**/*.rb
|
||||
**/*.rb
|
||||
-
|
||||
*.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.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
<p class="note private">
|
||||
<strong>This <%= object.type %> is part of an internal API.</strong>
|
||||
This <%= object.type %> may only be used internally in repositories owned by <a href="https://github.com/Homebrew">Homebrew</a>, 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.
|
||||
</p>
|
||||
|
@ -1,5 +1,5 @@
|
||||
<p class="note private">
|
||||
<strong>This <%= object.type %> is part of a private API.</strong>
|
||||
This <%= object.type %> may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> 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.
|
||||
</p>
|
||||
|
@ -0,0 +1,3 @@
|
||||
<div id="footer">
|
||||
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
|
||||
</div>
|
Loading…
x
Reference in New Issue
Block a user