Add missing headers to Action Mailbox/Mailer/Text/View docs [ci-skip]
Having a h1 heading will improve SEO and makes things look more consistent.
This commit is contained in:
parent
e726dbc2ac
commit
c09f5fa956
@ -6,6 +6,8 @@
|
||||
require "action_mailbox/routing"
|
||||
|
||||
module ActionMailbox
|
||||
# = Action Mailbox \Base
|
||||
#
|
||||
# The base class for all application mailboxes. Not intended to be inherited from directly. Inherit from
|
||||
# +ApplicationMailbox+ instead, as that's where the app-specific routing is configured. This routing
|
||||
# is specified in the following ways:
|
||||
|
@ -3,6 +3,8 @@
|
||||
require "active_support/callbacks"
|
||||
|
||||
module ActionMailbox
|
||||
# = Action Mailbox \Callbacks
|
||||
#
|
||||
# Defines the callbacks related to processing.
|
||||
module Callbacks
|
||||
extend ActiveSupport::Concern
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionMailbox
|
||||
# = Action Mailbox \Router
|
||||
#
|
||||
# Encapsulates the routes that live on the ApplicationMailbox and performs the actual routing when
|
||||
# an inbound_email is received.
|
||||
class Router
|
||||
|
@ -10,6 +10,8 @@
|
||||
require "action_mailer/rescuable"
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \Base
|
||||
#
|
||||
# Action Mailer allows you to send email from your application using a mailer model and views.
|
||||
#
|
||||
# = Mailer Models
|
||||
|
@ -3,6 +3,8 @@
|
||||
require "tmpdir"
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \DeliveryMethods
|
||||
#
|
||||
# This module handles everything related to mail delivery, from registering
|
||||
# new delivery methods to configuring the mail object to be sent.
|
||||
module DeliveryMethods
|
||||
|
@ -3,6 +3,8 @@
|
||||
require "base64"
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \InlinePreviewInterceptor
|
||||
#
|
||||
# Implements a mailer preview interceptor that converts image tag src attributes
|
||||
# that use inline cid: style URLs to data: style URLs so that they are visible
|
||||
# when previewing an HTML email in a web browser.
|
||||
|
@ -3,6 +3,8 @@
|
||||
require "active_support/log_subscriber"
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \LogSubscriber
|
||||
#
|
||||
# Implements the ActiveSupport::LogSubscriber for logging notifications when
|
||||
# email is delivered or received.
|
||||
class LogSubscriber < ActiveSupport::LogSubscriber
|
||||
|
@ -3,6 +3,8 @@
|
||||
require "active_job"
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \MailDeliveryJob
|
||||
#
|
||||
# The <tt>ActionMailer::MailDeliveryJob</tt> class is used when you
|
||||
# want to send emails outside of the request-response cycle. It supports
|
||||
# sending either parameterized or normal mail.
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \MailHelper
|
||||
#
|
||||
# Provides helper methods for ActionMailer::Base that can be used for easily
|
||||
# formatting messages, accessing mailer or message instances, and the
|
||||
# attachments list.
|
||||
|
@ -3,6 +3,8 @@
|
||||
require "delegate"
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \MessageDelivery
|
||||
#
|
||||
# The <tt>ActionMailer::MessageDelivery</tt> class is used by
|
||||
# ActionMailer::Base when creating a new mailer.
|
||||
# <tt>MessageDelivery</tt> is a wrapper (+Delegator+ subclass) around a lazy
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionMailer
|
||||
# = Action Mailer \Parameterized
|
||||
#
|
||||
# Provides the option to parameterize mailers in order to share instance variable
|
||||
# setup, processing, and common headers.
|
||||
#
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionMailer # :nodoc:
|
||||
# = Action Mailer \Rescuable
|
||||
#
|
||||
# Provides +rescue_from+ for mailers. Wraps mailer action processing,
|
||||
# mail job processing, and mail delivery.
|
||||
module Rescuable
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionText
|
||||
# = Action Text \RichText
|
||||
#
|
||||
# The RichText record holds the content produced by the Trix editor in a serialized +body+ attribute.
|
||||
# It also holds all the references to the embedded files, which are stored using Active Storage.
|
||||
# This record is then associated with the Active Record model the application desires to have
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionText
|
||||
# = Action Text \FixtureSet
|
||||
#
|
||||
# Fixtures are a way of organizing data that you want to test against; in
|
||||
# short, sample data.
|
||||
#
|
||||
|
@ -10,7 +10,7 @@
|
||||
require "action_view/lookup_context"
|
||||
|
||||
module ActionView # :nodoc:
|
||||
# = Action View Base
|
||||
# = Action View \Base
|
||||
#
|
||||
# Action View templates can be written in several ways.
|
||||
# If the template file has a <tt>.erb</tt> extension, then it uses the erubi[https://rubygems.org/gems/erubi]
|
||||
|
@ -4,6 +4,8 @@
|
||||
require "active_support/core_ext/module/redefine_method"
|
||||
|
||||
module ActionView
|
||||
# = Action View \Layouts
|
||||
#
|
||||
# Layouts reverse the common pattern of including shared headers and footers in many templates to isolate changes in
|
||||
# repeated setups. The inclusion pattern has pages that look like this:
|
||||
#
|
||||
|
@ -4,6 +4,8 @@
|
||||
require "action_view/model_naming"
|
||||
|
||||
module ActionView
|
||||
# = Action View \Record \Identifier
|
||||
#
|
||||
# RecordIdentifier encapsulates methods used by various ActionView helpers
|
||||
# to associate records with DOM elements.
|
||||
#
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionView
|
||||
# = Action View \Renderer
|
||||
#
|
||||
# This is the main entry point for rendering. It basically delegates
|
||||
# to other objects like TemplateRenderer and PartialRenderer which
|
||||
# actually renders the template.
|
||||
|
@ -1,6 +1,8 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module ActionView
|
||||
# = Action View \TemplatePath
|
||||
#
|
||||
# Represents a template path within ActionView's lookup and rendering system,
|
||||
# like "users/show"
|
||||
#
|
||||
|
Loading…
Reference in New Issue
Block a user