Merge pull request #11014 from reitermarkus/yard-config

Adjust YARD config.
This commit is contained in:
Markus Reiter 2021-04-03 02:41:37 +02:00 committed by GitHub
commit 911198f7f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 7 additions and 3 deletions

View File

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

View File

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

View File

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

View File

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

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>