Index (IKE Doc Maven Plugin 89 API)

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

ACTIVE - Enum constant in enum class network.ike.docs.plugin.diff.StampRegistry.Status: A new or replacing version of the text.
activeRef(int) - Method in interface network.ike.docs.plugin.diff.AdocDiffMarker.StampSource: The footnote macro for an Active region (insertion or replacement) whose last new-side line has the given index.
ADDED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus: Absent on the from side, present on the to side.
AdocDiffMarker - Class in network.ike.docs.plugin.diff: Marks the differences between two versions of an AsciiDoc fragment as inline [.diff-ins]#…# / [.diff-del]#…# roles, producing a renderable "marked copy" for a doc-diff review packet (ike-issues#648, #649).
AdocDiffMarker.MarkResult - Record Class in network.ike.docs.plugin.diff: The result of marking one fragment: the marked lines, word-level insertion/deletion counts, and the notes describing changes to protected constructs.
AdocDiffMarker.StampSource - Interface in network.ike.docs.plugin.diff: Source of STAMP endnote refs for marked regions (ike-issues#656).
ADOCSTUDIO - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:adocstudio — edit the project in AsciiDocFX.
AdocStudioMojo - Class in network.ike.docs.plugin: Generate Adoc Studio sidecar projects for assembly modules.
AdocStudioMojo() - Constructor for class network.ike.docs.plugin.AdocStudioMojo: Creates this goal instance.
anchorOf(List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler: Find a fragment's anchor id ([[id]]).
ASCIIDOC - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:asciidoc — render AsciiDoc to HTML, DocBook, and Prawn PDF.
AsciidocMojo - Class in network.ike.docs.plugin: Generate documentation from AsciiDoc sources using AsciidoctorJ.
AsciidocMojo() - Constructor for class network.ike.docs.plugin.AsciidocMojo: Creates this goal instance.
asciidoctorName() - Method in enum class network.ike.docs.plugin.Backend: The backend name as AsciidoctorJ expects it.
assemblyRefs(String) - Method in class network.ike.docs.plugin.diff.RegistryIndex: An assembly's flattened topic-refs, in document order.
author() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns the value of the author record component.
author() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the author record component.

B

Backend - Enum Class in network.ike.docs.plugin: AsciiDoc output backends supported by the AsciidocMojo.
blameInRange(String, String, Set) - Method in class network.ike.docs.plugin.diff.GitSource: Attribute each line of a file's to-side text to the range commit that introduced it (ike-issues#656).
branch() - Method in class network.ike.docs.plugin.diff.GitSource: The current branch name — the git-era analogue of the STAMP path coordinate.
branch() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the branch record component.
byName(String) - Static method in enum class network.ike.docs.plugin.IdocGoal: Look up a goal by its bare name (e.g.

C

change() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Returns the value of the change record component.
Change(ChangeStatus, String, String) - Constructor for record class network.ike.docs.plugin.diff.GitSource.Change: Creates an instance of a Change record class.
ChangeEntity(String, String, String, List, List) - Constructor for record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Creates an instance of a ChangeEntity record class.
ChangeManifest - Class in network.ike.docs.plugin.diff: The change-entity manifest behind a review packet (ike-issues#648).
ChangeManifest.ChangeEntity - Record Class in network.ike.docs.plugin.diff: One named change.
changes() - Method in class network.ike.docs.plugin.diff.ChangeManifest: The manifest's change entities, in authored or derived order.
changes(String, String, String, String) - Method in class network.ike.docs.plugin.diff.GitSource: List the files that differ between the two sides, with rename detection, filtered to a path prefix and suffix.
ChangeStatus - Enum Class in network.ike.docs.plugin.diff: Per-file status of a compared AsciiDoc source between the two sides of a doc-diff comparison (ike-issues#649).
close() - Method in class network.ike.docs.plugin.diff.GitSource
commitId() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the commitId record component.
CommitMeta(String, String, String, String, String, List) - Constructor for record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Creates an instance of a CommitMeta record class.
commitsBetween(String, String) - Method in class network.ike.docs.plugin.diff.GitSource: Walk the commits reachable from toRef and not from fromRef (i.e.
COPY_DEFAULT_PDF - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:copy-default-pdf — copy the default-renderer PDF to the site.
COPY_DOCS - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:copy-docs — copy rendered docs into the site.
COPY_EXTENSIONS - Static variable in class network.ike.docs.plugin.CopyDocsToSiteMojo: File extensions to copy from generated-docs to the site.
CopyDefaultPdfMojo - Class in network.ike.docs.plugin: Copy the selected renderer's PDF to the default pdf/ directory.
CopyDefaultPdfMojo() - Constructor for class network.ike.docs.plugin.CopyDefaultPdfMojo: Creates this goal instance.
CopyDocsToSiteMojo - Class in network.ike.docs.plugin: Copy rendered HTML docs and assets into the Maven site output directory.
CopyDocsToSiteMojo() - Constructor for class network.ike.docs.plugin.CopyDocsToSiteMojo: Creates this goal instance.
countBareRects(String) - Static method in class network.ike.docs.plugin.FixSvgMojo: Count occurrences of bare <rect/> elements in HTML content.
countErrors(String) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo: Count lines containing error patterns in log content.

D

date() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns the value of the date record component.
DELETED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus: Present on the from side, absent on the to side.
delWords() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Returns the value of the delWords record component.
derive(List) - Static method in class network.ike.docs.plugin.diff.ChangeManifest: Derive a manifest from a commit range by grouping commits on their first Refs:/Fixes: trailer.
description() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns the value of the description record component.
description() - Method in enum class network.ike.docs.plugin.IdocGoal: One-line human description of what this goal does.
DIFF - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:diff — generate and render a doc-diff review packet (#648).
displayPath() - Method in record class network.ike.docs.plugin.diff.GitSource.Change: The path a reader should know this file by — the to side when present, otherwise the from side.
DOCBOOK - Enum constant in enum class network.ike.docs.plugin.Backend: DocBook 5 — intermediate XML for XEP/FOP XSL-FO pipelines.
DocDiffMojo - Class in network.ike.docs.plugin: Generate and render a doc-diff review packet: every changed AsciiDoc fragment between two refs (or a ref and the working tree), marked inline with [.diff-ins]/[.diff-del] roles and composed into a book with a cover summary, Record of Changes, Change Glossary, Change Index, registry delta, and assembly scaffolding diffs (ike-issues#648, #649, #650; design note dev-doc-diff-pipeline in ike-lab-documents).
DocDiffMojo() - Constructor for class network.ike.docs.plugin.DocDiffMojo

E

equals(Object) - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.GitSource.Change: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class network.ike.docs.plugin.OutputValidator.Severity: Fatal issue when strict mode is enabled (e.g., unresolved attribute).
execute() - Method in class network.ike.docs.plugin.AdocStudioMojo
execute() - Method in class network.ike.docs.plugin.AsciidocMojo
execute() - Method in class network.ike.docs.plugin.CopyDefaultPdfMojo
execute() - Method in class network.ike.docs.plugin.CopyDocsToSiteMojo
execute() - Method in class network.ike.docs.plugin.DocDiffMojo
execute() - Method in class network.ike.docs.plugin.FixSvgMojo
execute() - Method in class network.ike.docs.plugin.InjectBreadcrumbMojo
execute() - Method in class network.ike.docs.plugin.LintSiteMojo
execute() - Method in class network.ike.docs.plugin.PackageDocMojo
execute() - Method in class network.ike.docs.plugin.PatchDocbookMojo
execute() - Method in class network.ike.docs.plugin.PrepareRendererOutputMojo
execute() - Method in class network.ike.docs.plugin.RenderPdfMojo
execute() - Method in class network.ike.docs.plugin.ScanRendererLogsMojo
expectedBodyClassFor(String) - Static method in class network.ike.docs.plugin.LintSiteMojo: Return the expected <bodyClass> for a deployment target.
extractRendererName(String) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo: Extract the renderer name from a log filename.

F

file() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns the value of the file record component.
files() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns the value of the files record component.
files() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns the value of the files record component.
findPath(String, String) - Method in class network.ike.docs.plugin.diff.GitSource: Find the first path on a side that ends with the given suffix — used to discover the topic-registry source root from an assembly module (ike-issues#649 subproject scoping).
FIX_SVG - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:fix-svg — post-process SVGs for PDF renderer compatibility.
FixSvgMojo - Class in network.ike.docs.plugin: Remove bare <rect/> elements from generated HTML files.
FixSvgMojo() - Constructor for class network.ike.docs.plugin.FixSvgMojo: Creates this goal instance.
footnote(String, StampRegistry.Status, String) - Method in class network.ike.docs.plugin.diff.StampRegistry: The reusable footnote macro for one attribution + status.
footnoteId() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the footnoteId record component.
formatSummary(String, int, int) - Static method in class network.ike.docs.plugin.ScanRendererLogsMojo: Format a one-line summary for a renderer log.
fullMessage() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns the value of the fullMessage record component.

G

generateThemeCss() - Static method in class network.ike.docs.plugin.InjectBreadcrumbMojo: Generate the IKE theme override CSS for JaCoCo reports.
getLog() - Method in class network.ike.docs.plugin.AdocStudioMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.AsciidocMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.CopyDefaultPdfMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.CopyDocsToSiteMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.DocDiffMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.FixSvgMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.InjectBreadcrumbMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.LintSiteMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.PackageDocMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.PatchDocbookMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.PrepareRendererOutputMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.RenderPdfMojo: Access the Maven logger.
getLog() - Method in class network.ike.docs.plugin.ScanRendererLogsMojo: Access the Maven logger.
GitSource - Class in network.ike.docs.plugin.diff: Read-only access to both sides of a doc-diff comparison (ike-issues#649): any two commits, or a commit and the working tree.
GitSource.Change - Record Class in network.ike.docs.plugin.diff: One changed file between the two sides.
GitSource.CommitMeta - Record Class in network.ike.docs.plugin.diff: Metadata of one commit in a compared range, for change-entity derivation from trailers (ike-issues#652) and stamp endnotes (ike-issues#656).
goalName() - Method in enum class network.ike.docs.plugin.IdocGoal: The bare goal name as it appears in @Mojo(name = ...).

H

hashCode() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.GitSource.Change: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns a hash code value for this object.
hashCode() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns a hash code value for this object.
HTML - Enum constant in enum class network.ike.docs.plugin.Backend: HTML5 — website and CSS-to-PDF renderer input.

I

id() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns the value of the id record component.
id() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns the value of the id record component.
IdocGoal - Enum Class in network.ike.docs.plugin: Compile-time identity for every idoc:* goal in this plugin.
INACTIVE - Enum constant in enum class network.ike.docs.plugin.diff.StampRegistry.Status: An unpaired deletion — an inactivation.
inactiveRef() - Method in interface network.ike.docs.plugin.diff.AdocDiffMarker.StampSource: The footnote macro for an Inactive region (unpaired deletion).
INJECT_BREADCRUMB - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:inject-breadcrumb — inject breadcrumbs into rendered HTML.
injectBreadcrumb(String, String, String) - Static method in class network.ike.docs.plugin.InjectBreadcrumbMojo: Inject a breadcrumb navigation link into JaCoCo's breadcrumb div.
InjectBreadcrumbMojo - Class in network.ike.docs.plugin: Inject navigation breadcrumbs and theme overrides into JaCoCo HTML reports.
InjectBreadcrumbMojo() - Constructor for class network.ike.docs.plugin.InjectBreadcrumbMojo: Creates this goal instance.
injectChangeTerms(List, List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler: Inject one silent change-index term per owning change after a fragment's level-1 title, so the ordinary [index] section collects a change → pages mapping.
injectThemeCssLink(String) - Static method in class network.ike.docs.plugin.InjectBreadcrumbMojo: Inject a CSS link to the IKE theme override after the existing report.css link.
insWords() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Returns the value of the insWords record component.
Issue(Path, int, OutputValidator.Severity, String) - Constructor for record class network.ike.docs.plugin.OutputValidator.Issue: Creates an instance of a Issue record class.

L

label() - Method in enum class network.ike.docs.plugin.diff.StampRegistry.Status: The label as printed in endnotes and the register.
line() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns the value of the line record component.
lines() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Returns the value of the lines record component.
lint(String, String, String, String) - Static method in class network.ike.docs.plugin.LintSiteMojo: Apply all site.xml lint rules to the given content.
LINT_SITE - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:lint-site — lint src/site/site.xml for IKE theme/breadcrumb drift (#319).
LintSiteMojo - Class in network.ike.docs.plugin: Lint src/site/site.xml for IKE Network theme + breadcrumb conventions (ike-issues#319).
LintSiteMojo() - Constructor for class network.ike.docs.plugin.LintSiteMojo: Creates this goal instance.
listYaml(String, String) - Method in class network.ike.docs.plugin.diff.GitSource: List the immediate .yaml children of a directory on a side — used to enumerate per-domain registry files on both sides of the comparison.
load(Path) - Static method in class network.ike.docs.plugin.diff.ChangeManifest: Load an authored manifest.
load(GitSource, String, String) - Static method in class network.ike.docs.plugin.diff.RegistryIndex: Load the registry as it stands on one side of a comparison.

M

mark(List, List) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker: Produce a marked copy of a changed fragment, without stamps.
mark(List, List, AdocDiffMarker.StampSource) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker: Produce a marked copy of a changed fragment, with optional STAMP endnote refs per change boundary.
markAdded(List, String) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker: Produce a full-text copy of an added fragment with a banner note instead of inline marks.
markAdded(List, String, String) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker: Produce a full-text copy of an added fragment with a banner note, optionally stamped — an added topic is one Active stamp, carried on the banner rather than in the flow.
MarkResult(List, int, int, List) - Constructor for record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Creates an instance of a MarkResult record class.
masterDoc(String, String, String, List, List, ChangeManifest, List, boolean, List, String, List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler: Compose the packet master document.
membershipDelta(GitSource, String, String, String, String) - Static method in class network.ike.docs.plugin.diff.RegistryIndex: Render one assembly's membership delta (topic-refs added and removed between two sides) as a small registry-delta partial for an assembly-projection packet.
message() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns the value of the message record component.
MODIFIED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus: Present on both sides with differing content.
module() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the module record component.
mojoClass() - Method in enum class network.ike.docs.plugin.IdocGoal: The mojo class that implements this goal.
multipleStampsPossible(boolean) - Method in class network.ike.docs.plugin.diff.StampRegistry: Whether the packet can carry more than one distinct stamp; when not, in-flow refs are suppressed and the cover states the single stamp once.

N

network.ike.docs.plugin - package network.ike.docs.plugin
network.ike.docs.plugin.diff - package network.ike.docs.plugin.diff
newPath() - Method in record class network.ike.docs.plugin.diff.GitSource.Change: Returns the value of the newPath record component.
notes() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Returns the value of the notes record component.

O

of(List) - Static method in class network.ike.docs.plugin.diff.ChangeManifest: Build a manifest from already-constructed entities — used to merge trailer-derived entities for a committed range with a synthetic uncommitted entity when the to side is the working tree.
oldPath() - Method in record class network.ike.docs.plugin.diff.GitSource.Change: Returns the value of the oldPath record component.
open(Path) - Static method in class network.ike.docs.plugin.diff.GitSource: Open the repository that contains the given directory, walking upward to find the git dir (a module's basedir is typically below the repository root).
outName() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Returns the value of the outName record component.
outputSubdir() - Method in enum class network.ike.docs.plugin.Backend: Default output subdirectory under the goal's output root.
OutputValidator - Class in network.ike.docs.plugin: Scans generated AsciiDoc output for common conversion problems.
OutputValidator() - Constructor for class network.ike.docs.plugin.OutputValidator: Creates a new output validator.
OutputValidator.Issue - Record Class in network.ike.docs.plugin: A single validation issue found in a generated file.
OutputValidator.Severity - Enum Class in network.ike.docs.plugin: Severity levels for validation issues.

P

PACKAGE_DOC - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:package-doc — package rendered docs as an ike-doc artifact.
PackageDocMojo - Class in network.ike.docs.plugin: Package AsciiDoc sources as the primary artifact for ike-doc packaging.
PackageDocMojo() - Constructor for class network.ike.docs.plugin.PackageDocMojo: Creates this goal instance.
PacketAssembler - Class in network.ike.docs.plugin.diff: Composes the review packet's generated AsciiDoc (ike-issues#648): the master document with cover sheet, change summary, Record of Changes, per-topic includes, Change Glossary, and Change Index, plus the unified-diff listings for assembly scaffolding files.
PacketAssembler.ScaffoldEntry - Record Class in network.ike.docs.plugin.diff: One scaffolding (non-fragment) AsciiDoc change shown as a unified-diff listing.
PacketAssembler.TopicEntry - Record Class in network.ike.docs.plugin.diff: One marked topic destined for the packet.
parse(String) - Static method in enum class network.ike.docs.plugin.Backend: Parse a backend name (case-insensitive).
PATCH_DOCBOOK - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:patch-docbook — apply local patches to DocBook XSL output.
PatchDocbookMojo - Class in network.ike.docs.plugin: Patch stock DocBook XSL stylesheets to suppress Saxon warnings.
PatchDocbookMojo() - Constructor for class network.ike.docs.plugin.PatchDocbookMojo: Creates this goal instance.
path() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry: Returns the value of the path record component.
PDF - Enum constant in enum class network.ike.docs.plugin.Backend: Prawn PDF — direct AsciiDoc-to-PDF via JRuby.
PLUGIN_PREFIX - Static variable in enum class network.ike.docs.plugin.IdocGoal: Shared idoc: prefix for all goals in this plugin.
pluginPrefix() - Method in enum class network.ike.docs.plugin.IdocGoal: The idoc plugin prefix — shared by every goal in this enum.
PREPARE_RENDERER_OUTPUT - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:prepare-renderer-output — prepare per-renderer output dirs.
PrepareRendererOutputMojo - Class in network.ike.docs.plugin: Create output directories for external PDF renderers.
PrepareRendererOutputMojo() - Constructor for class network.ike.docs.plugin.PrepareRendererOutputMojo: Creates this goal instance.

Q

qualified() - Method in enum class network.ike.docs.plugin.IdocGoal: The fully-qualified goal invocation, e.g.

R

read(String, String) - Method in class network.ike.docs.plugin.diff.GitSource: Read one file's text from a side.
refs() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns the value of the refs record component.
refs() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the refs record component.
RegistryDelta - Class in network.ike.docs.plugin.diff: Entry-keyed delta of the IKE topic registry between the two sides of a doc-diff comparison, rendered as an AsciiDoc partial (ike-issues#650).
RegistryDelta(GitSource, String, String) - Constructor for class network.ike.docs.plugin.diff.RegistryDelta: Create a delta generator over one comparison.
RegistryIndex - Class in network.ike.docs.plugin.diff: One side's view of the IKE topic registry: topic id → source file and assembly id → flattened topic-refs.
removeBareRects(String) - Static method in class network.ike.docs.plugin.FixSvgMojo: Remove all bare <rect/> elements from HTML content.
removeDeadVariable(String) - Static method in class network.ike.docs.plugin.PatchDocbookMojo: Remove the dead <xsl:variable name="output.delims"> block from DocBook's fo/math.xsl.
removeUtilityInclude(String) - Static method in class network.ike.docs.plugin.PatchDocbookMojo: Remove the <xsl:include href="../common/utility.xsl"/> line from DocBook's fo/docbook.xsl.
RENAMED - Enum constant in enum class network.ike.docs.plugin.diff.ChangeStatus: Moved between paths (content compared across the rename).
render(String, String) - Method in class network.ike.docs.plugin.diff.RegistryDelta: Render the delta as an AsciiDoc partial with a level-1 title.
RENDER_PDF - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:render-pdf — render AsciiDoc to PDF via a configured renderer.
RenderPdfMojo - Class in network.ike.docs.plugin: Render PDF from intermediate files using an external renderer.
RenderPdfMojo() - Constructor for class network.ike.docs.plugin.RenderPdfMojo: Creates this goal instance.
result() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Returns the value of the result record component.

S

ScaffoldEntry(String, String) - Constructor for record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry: Creates an instance of a ScaffoldEntry record class.
SCAN_LOGS - Enum constant in enum class network.ike.docs.plugin.IdocGoal: idoc:scan-logs — scan renderer logs for warnings and errors.
ScanRendererLogsMojo - Class in network.ike.docs.plugin: Scan renderer log files for error patterns and print a summary.
ScanRendererLogsMojo() - Constructor for class network.ike.docs.plugin.ScanRendererLogsMojo: Creates this goal instance.
severity() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns the value of the severity record component.
shouldCopy(String) - Static method in class network.ike.docs.plugin.CopyDocsToSiteMojo: Check whether a filename has an extension in the copy list.
singleStampLine(String) - Method in class network.ike.docs.plugin.diff.StampRegistry: Render the single stamp's coordinate line for the cover when in-flow refs are suppressed.
Stamp(String, StampRegistry.Status, String, String, String, String, String, String) - Constructor for record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Creates an instance of a Stamp record class.
StampRegistry - Class in network.ike.docs.plugin.diff: The packet's stamp set (ike-issues#656): one STAMP per (range commit, status) pair, plus the uncommitted pair for working-tree marks.
StampRegistry(List, String, String, String, String) - Constructor for class network.ike.docs.plugin.diff.StampRegistry: Create the registry for one packet.
StampRegistry.Stamp - Record Class in network.ike.docs.plugin.diff: One stamp as used somewhere in the packet.
StampRegistry.Status - Enum Class in network.ike.docs.plugin.diff: Marked-region status, stated redundantly in each endnote.
status() - Method in record class network.ike.docs.plugin.diff.GitSource.Change: Returns the value of the status record component.
status() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the status record component.
subject() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns the value of the subject record component.
supportsPostprocessor() - Method in enum class network.ike.docs.plugin.Backend: Whether this backend supports AsciidoctorJ Postprocessor extensions.

T

time() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns the value of the time record component.
title() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns the value of the title record component.
TopicEntry(GitSource.Change, String, AdocDiffMarker.MarkResult) - Constructor for record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Creates an instance of a TopicEntry record class.
topicFile(String) - Method in class network.ike.docs.plugin.diff.RegistryIndex: Resolve a topic id to its source file, relative to the registry root (e.g.
toString() - Method in record class network.ike.docs.plugin.diff.AdocDiffMarker.MarkResult: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.ChangeManifest.ChangeEntity: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.GitSource.Change: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.GitSource.CommitMeta: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.TopicEntry: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.diff.StampRegistry.Stamp: Returns a string representation of this record class.
toString() - Method in record class network.ike.docs.plugin.OutputValidator.Issue: Returns a string representation of this record class.

U

UNCOMMITTED - Static variable in class network.ike.docs.plugin.diff.GitSource: Attribution value for working-tree lines not yet committed.
unifiedDiff() - Method in record class network.ike.docs.plugin.diff.PacketAssembler.ScaffoldEntry: Returns the value of the unifiedDiff record component.
unifiedDiff(String, List, List) - Static method in class network.ike.docs.plugin.diff.PacketAssembler: Produce a unified diff for a scaffolding file.
usedStamps() - Method in class network.ike.docs.plugin.diff.StampRegistry: The stamps actually used in this packet, in first-use order.
userName() - Method in class network.ike.docs.plugin.diff.GitSource: The configured user name, used as the author of uncommitted (working-tree) stamps.

V

validate(Path, Backend) - Method in class network.ike.docs.plugin.OutputValidator: Validate all files in the given output directory.
valueOf(String) - Static method in enum class network.ike.docs.plugin.Backend: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.diff.ChangeStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.diff.StampRegistry.Status: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.IdocGoal: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class network.ike.docs.plugin.OutputValidator.Severity: Returns the enum constant of this class with the specified name.
values() - Static method in enum class network.ike.docs.plugin.Backend: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.diff.ChangeStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.diff.StampRegistry.Status: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.IdocGoal: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class network.ike.docs.plugin.OutputValidator.Severity: Returns an array containing the constants of this enum class, in the order they are declared.

W

WARNING - Enum constant in enum class network.ike.docs.plugin.OutputValidator.Severity: Non-fatal issue (e.g., missing image).
withDiagramHistory(List, List) - Static method in class network.ike.docs.plugin.diff.AdocDiffMarker: Append, after every diagram block whose body meaningfully changed between the two sides, the compact source delta followed by the rendered previous version — so the reader sees the new drawing, what changed in the spec, and the old drawing, in that order.
workTree() - Method in class network.ike.docs.plugin.diff.GitSource: The repository's working-tree root.
WORKTREE - Static variable in class network.ike.docs.plugin.diff.GitSource: Pseudo-ref naming the uncommitted working tree as a side.

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values