apidoc: update URLs

This commit is contained in:
EricFromCanada 2020-11-03 12:39:26 -05:00
parent 0e36cdcf0f
commit d293431b87
9 changed files with 16 additions and 18 deletions

View File

@ -4,6 +4,6 @@ This is the public API for 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.
You may also find the [Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) and [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide) helpful in creating formulae. 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! Good luck!

View File

@ -69,7 +69,7 @@ module DiskUsageExtension
end end
# Homebrew extends Ruby's `Pathname` to make our code more readable. # Homebrew extends Ruby's `Pathname` to make our code more readable.
# @see https://ruby-doc.org/stdlib-1.8.7/libdoc/pathname/rdoc/Pathname.html Ruby's Pathname API # @see https://ruby-doc.org/stdlib-2.6.3/libdoc/pathname/rdoc/Pathname.html Ruby's Pathname API
class Pathname class Pathname
include DiskUsageExtension include DiskUsageExtension

View File

@ -39,7 +39,7 @@ require "utils/spdx"
# @see Pathname # @see Pathname
# @see https://www.rubydoc.info/stdlib/fileutils FileUtils # @see https://www.rubydoc.info/stdlib/fileutils FileUtils
# @see https://docs.brew.sh/Formula-Cookbook Formula Cookbook # @see https://docs.brew.sh/Formula-Cookbook Formula Cookbook
# @see https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide Ruby Style Guide # @see https://rubystyle.guide Ruby Style Guide
# #
# <pre>class Wget < Formula # <pre>class Wget < Formula
# homepage "https://www.gnu.org/software/wget/" # homepage "https://www.gnu.org/software/wget/"
@ -2374,7 +2374,7 @@ class Formula
# and you haven't passed or previously used any options on this formula. # and you haven't passed or previously used any options on this formula.
# #
# If you maintain your own repository, you can add your own bottle links. # If you maintain your own repository, you can add your own bottle links.
# @see https://docs.brew.sh/Bottles # @see https://docs.brew.sh/Bottles Bottles
# You can ignore this block entirely if submitting to Homebrew/homebrew-core. # You can ignore this block entirely if submitting to Homebrew/homebrew-core.
# It'll be handled for you by the Brew Test Bot. # It'll be handled for you by the Brew Test Bot.
# #
@ -2597,6 +2597,7 @@ class Formula
# to provide multiple embedded patches while making only some of them # to provide multiple embedded patches while making only some of them
# conditional. # conditional.
# <pre>patch :p0, "..."</pre> # <pre>patch :p0, "..."</pre>
# @see https://docs.brew.sh/Formula-Cookbook#patches Patches
def patch(strip = :p1, src = nil, &block) def patch(strip = :p1, src = nil, &block)
specs.each { |spec| spec.patch(strip, src, &block) } specs.each { |spec| spec.patch(strip, src, &block) }
end end
@ -2696,7 +2697,7 @@ class Formula
# and foo --version and foo --help are bad tests. # and foo --version and foo --help are bad tests.
# However, a bad test is better than no test at all. # However, a bad test is better than no test at all.
# #
# See: https://docs.brew.sh/Formula-Cookbook#add-a-test-to-the-formula # @see https://docs.brew.sh/Formula-Cookbook#add-a-test-to-the-formula Tests
# #
# <pre>(testpath/"test.file").write <<~EOS # <pre>(testpath/"test.file").write <<~EOS
# writing some test file, if you need to # writing some test file, if you need to

View File

@ -89,7 +89,7 @@ class Keg
).map { |dir| HOMEBREW_PREFIX/dir }.sort.uniq.freeze ).map { |dir| HOMEBREW_PREFIX/dir }.sort.uniq.freeze
# Keep relatively in sync with # Keep relatively in sync with
# https://github.com/Homebrew/install/blob/HEAD/install # {https://github.com/Homebrew/install/blob/HEAD/install.sh}
MUST_EXIST_DIRECTORIES = (MUST_EXIST_SUBDIRECTORIES + [ MUST_EXIST_DIRECTORIES = (MUST_EXIST_SUBDIRECTORIES + [
HOMEBREW_CELLAR, HOMEBREW_CELLAR,
].sort.uniq).freeze ].sort.uniq).freeze

View File

@ -6,7 +6,7 @@
# @api private # @api private
module Metafiles module Metafiles
LICENSES = Set.new(%w[copying copyright license licence]).freeze LICENSES = Set.new(%w[copying copyright license licence]).freeze
# https://github.com/github/markup#markups # {https://github.com/github/markup#markups}
EXTENSIONS = Set.new(%w[ EXTENSIONS = Set.new(%w[
.adoc .asc .asciidoc .creole .html .markdown .md .mdown .mediawiki .mkdn .adoc .asc .asciidoc .creole .html .markdown .md .mdown .mediawiki .mkdn
.org .pod .rdoc .rst .rtf .textile .txt .wiki .org .pod .rdoc .rst .rtf .textile .txt .wiki

View File

@ -45,14 +45,14 @@ module OS
def latest_stable_version def latest_stable_version
# TODO: bump version when new macOS is released and also update # TODO: bump version when new macOS is released and also update
# references in docs/Installation.md and # references in docs/Installation.md and
# https://github.com/Homebrew/install/blob/HEAD/install # https://github.com/Homebrew/install/blob/HEAD/install.sh
Version.new "10.15" Version.new "10.15"
end end
def outdated_release? def outdated_release?
# TODO: bump version when new macOS is released and also update # TODO: bump version when new macOS is released and also update
# references in docs/Installation.md and # references in docs/Installation.md and
# https://github.com/Homebrew/install/blob/HEAD/install # https://github.com/Homebrew/install/blob/HEAD/install.sh
version < "10.13" version < "10.13"
end end
@ -143,9 +143,9 @@ module OS
# See these issues for some history: # See these issues for some history:
# #
# - https://github.com/Homebrew/legacy-homebrew/issues/13 # - {https://github.com/Homebrew/legacy-homebrew/issues/13}
# - https://github.com/Homebrew/legacy-homebrew/issues/41 # - {https://github.com/Homebrew/legacy-homebrew/issues/41}
# - https://github.com/Homebrew/legacy-homebrew/issues/48 # - {https://github.com/Homebrew/legacy-homebrew/issues/48}
def macports_or_fink def macports_or_fink
paths = [] paths = []

View File

@ -58,8 +58,7 @@ module OS
"2.7.11" "2.7.11"
end end
# - https://xquartz.macosforge.org/trac/wiki # @see https://www.xquartz.org/releases/index.html
# - https://xquartz.macosforge.org/trac/wiki/Releases
def latest_version def latest_version
"2.7.11" "2.7.11"
end end

View File

@ -7,8 +7,7 @@ module RuboCop
module Cop module Cop
module Cask module Cask
# This cop checks that a cask's stanzas are grouped correctly. # This cop checks that a cask's stanzas are grouped correctly.
# See https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order # @see https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order
# for more info.
class StanzaGrouping < Cop class StanzaGrouping < Cop
extend Forwardable extend Forwardable
include CaskHelp include CaskHelp

View File

@ -7,8 +7,7 @@ module RuboCop
module Cop module Cop
module Cask module Cask
# This cop checks that a cask's stanzas are ordered correctly. # This cop checks that a cask's stanzas are ordered correctly.
# See https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order # @see https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order
# for more info.
class StanzaOrder < Cop class StanzaOrder < Cop
extend Forwardable extend Forwardable
include CaskHelp include CaskHelp