Adjust YARD config.

This commit is contained in:
Markus Reiter 2021-04-03 02:09:22 +02:00
parent 0e71efb131
commit 695d44847a
No known key found for this signature in database
GPG Key ID: 245293B51702655B
5 changed files with 7 additions and 3 deletions

View File

@ -7,6 +7,7 @@
--exclude test/ --exclude test/
--exclude vendor/ --exclude vendor/
--exclude compat/ --exclude compat/
extend/os/**/*.rb
**/*.rb **/*.rb
- -
*.md *.md

View File

@ -1,6 +1,6 @@
# Homebrew Ruby API # 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. 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.

View File

@ -1,5 +1,5 @@
<p class="note private"> <p class="note private">
<strong>This <%= object.type %> is part of an internal API.</strong> <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. 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> </p>

View File

@ -1,5 +1,5 @@
<p class="note private"> <p class="note private">
<strong>This <%= object.type %> is part of a private API.</strong> <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. 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> </p>

View File

@ -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>