Skip to content

Commit

Permalink
[CI] Add Doctum build
Browse files Browse the repository at this point in the history
  • Loading branch information
@weitzman @actions-user
weitzman authored and actions-user committed Aug 14, 2024
1 parent 736a78a commit 18f51c7
Show file tree
Hide file tree
Showing 417 changed files with 511,503 additions and 445 deletions.
99 changes: 99 additions & 0 deletions api/Consolidation.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Consolidation | Drush API 13</title>

<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
<script src="js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="doctum.js"></script>
<script async defer src="js/bootstrap.min.js"></script>
<script async defer src="js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">

</head>

<body id="namespace" data-name="namespace:Consolidation" data-root-path="" data-search-index-url="doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Drush API 13</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="classes.html">Classes</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="interfaces.html">Interfaces</a></li>
<li><a href="traits.html">Traits</a></li>
<li><a href="doc-index.html">Index</a></li>
<li><a href="search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">Namespace</span></li>
<li><a href="Consolidation.html">Consolidation</a></li><li class="backslash">\</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Consolidation</h1>
</div>

<h2>Namespaces</h2>
<div class="namespace-list">
<a href="Consolidation/AnnotatedCommand.html">Consolidation\AnnotatedCommand</a><a href="Consolidation/OutputFormatters.html">Consolidation\OutputFormatters</a><a href="Consolidation/SiteAlias.html">Consolidation\SiteAlias</a> </div>





</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>

</html>
218 changes: 218 additions & 0 deletions api/Consolidation/AnnotatedCommand.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Consolidation\AnnotatedCommand | Drush API 13</title>

<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../css/doctum.css">
<link rel="stylesheet" type="text/css" href="../fonts/doctum-font.css">
<script src="../js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="../doctum.js"></script>
<script async defer src="../js/bootstrap.min.js"></script>
<script async defer src="../js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">

</head>

<body id="namespace" data-name="namespace:Consolidation_AnnotatedCommand" data-root-path="../" data-search-index-url="../doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="../search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>

<div id="api-tree"></div>

</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">Drush API 13</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../classes.html">Classes</a></li>
<li><a href="../namespaces.html">Namespaces</a></li>
<li><a href="../interfaces.html">Interfaces</a></li>
<li><a href="../traits.html">Traits</a></li>
<li><a href="../doc-index.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>

<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">Namespace</span></li>
<li><a href="../Consolidation.html">Consolidation</a></li><li class="backslash">\</li><li><a href="../Consolidation/AnnotatedCommand.html">AnnotatedCommand</a></li><li class="backslash">\</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Consolidation\AnnotatedCommand</h1>
</div>

<h2>Namespaces</h2>
<div class="namespace-list">
<a href="../Consolidation/AnnotatedCommand/Attributes.html">Consolidation\AnnotatedCommand\Attributes</a><a href="../Consolidation/AnnotatedCommand/Cache.html">Consolidation\AnnotatedCommand\Cache</a><a href="../Consolidation/AnnotatedCommand/Events.html">Consolidation\AnnotatedCommand\Events</a><a href="../Consolidation/AnnotatedCommand/Help.html">Consolidation\AnnotatedCommand\Help</a><a href="../Consolidation/AnnotatedCommand/Hooks.html">Consolidation\AnnotatedCommand\Hooks</a><a href="../Consolidation/AnnotatedCommand/Input.html">Consolidation\AnnotatedCommand\Input</a><a href="../Consolidation/AnnotatedCommand/Options.html">Consolidation\AnnotatedCommand\Options</a><a href="../Consolidation/AnnotatedCommand/Output.html">Consolidation\AnnotatedCommand\Output</a><a href="../Consolidation/AnnotatedCommand/Parser.html">Consolidation\AnnotatedCommand\Parser</a><a href="../Consolidation/AnnotatedCommand/State.html">Consolidation\AnnotatedCommand\State</a> </div>

<h2>Classes</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/AnnotatedCommand.html"><abbr title="Consolidation\AnnotatedCommand\AnnotatedCommand">AnnotatedCommand</abbr></a> </div>
<div class="col-md-6"><p>AnnotatedCommands are created automatically by the
AnnotatedCommandFactory. Each command method in a
command file will produce one AnnotatedCommand. These
are then added to your Symfony Console Application object;
nothing else is needed.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/AnnotatedCommandFactory.html"><abbr title="Consolidation\AnnotatedCommand\AnnotatedCommandFactory">AnnotatedCommandFactory</abbr></a> </div>
<div class="col-md-6"><p>The AnnotatedCommandFactory creates commands for your application.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/AnnotationData.html"><abbr title="Consolidation\AnnotatedCommand\AnnotationData">AnnotationData</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/CommandCreationListener.html"><abbr title="Consolidation\AnnotatedCommand\CommandCreationListener">CommandCreationListener</abbr></a> </div>
<div class="col-md-6"><p>Command cration listeners can be added to the annotation
command factory. These will be notified whenever a new
commandfile is provided to the factory. This is useful for
initializing new commandfile objects.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/CommandData.html"><abbr title="Consolidation\AnnotatedCommand\CommandData">CommandData</abbr></a> </div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/CommandError.html"><abbr title="Consolidation\AnnotatedCommand\CommandError">CommandError</abbr></a> </div>
<div class="col-md-6"><p>Return a CommandError as the result of a command to pass a status
code and error message to be displayed.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/CommandFileDiscovery.html"><abbr title="Consolidation\AnnotatedCommand\CommandFileDiscovery">CommandFileDiscovery</abbr></a> </div>
<div class="col-md-6"><p>Do discovery presuming that the namespace of the command will
contain the last component of the path. This is the convention
that should be used when searching for command files that are
bundled with the modules of a framework. The convention used
is that the namespace for a module in a framework should start with
the framework name followed by the module name.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/CommandProcessor.html"><abbr title="Consolidation\AnnotatedCommand\CommandProcessor">CommandProcessor</abbr></a> </div>
<div class="col-md-6"><p>Process a command, including hooks and other callbacks.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/CommandResult.html"><abbr title="Consolidation\AnnotatedCommand\CommandResult">CommandResult</abbr></a> </div>
<div class="col-md-6"><p>Return a CommandResult as the result of a command to pass both an exit
code and result data from a command.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/ParameterInjection.html"><abbr title="Consolidation\AnnotatedCommand\ParameterInjection">ParameterInjection</abbr></a> </div>
<div class="col-md-6"><p>Prepare parameter list for execurion. Handle injection of any
special values (e.g. $input and $output) into the parameter list.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../Consolidation/AnnotatedCommand/ResultWriter.html"><abbr title="Consolidation\AnnotatedCommand\ResultWriter">ResultWriter</abbr></a> </div>
<div class="col-md-6"><p>Write the results of a command. Inject your ResultWriter
into the CommandProcessor.</p></div>
</div>
</div>
<h2>Interfaces</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<em><a href="../Consolidation/AnnotatedCommand/CommandCreationListenerInterface.html"><abbr title="Consolidation\AnnotatedCommand\CommandCreationListenerInterface">CommandCreationListenerInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>Command cration listeners can be added to the annotation
command factory. These will be notified whenever a new
commandfile is provided to the factory. This is useful for
initializing new commandfile objects.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="../Consolidation/AnnotatedCommand/CommandInfoAltererInterface.html"><abbr title="Consolidation\AnnotatedCommand\CommandInfoAltererInterface">CommandInfoAltererInterface</abbr></a></em>
</div>
<div class="col-md-6"></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="../Consolidation/AnnotatedCommand/ExitCodeInterface.html"><abbr title="Consolidation\AnnotatedCommand\ExitCodeInterface">ExitCodeInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>If an annotated command method encounters an error, then it
should either throw an exception, or return a result object
that implements ExitCodeInterface.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="../Consolidation/AnnotatedCommand/OutputDataInterface.html"><abbr title="Consolidation\AnnotatedCommand\OutputDataInterface">OutputDataInterface</abbr></a></em>
</div>
<div class="col-md-6"><p>If an annotated command method returns an object that
implements OutputDataInterface, then the getOutputData()
method is used to fetch the output to print from the
result object.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="../Consolidation/AnnotatedCommand/ParameterInjector.html"><abbr title="Consolidation\AnnotatedCommand\ParameterInjector">ParameterInjector</abbr></a></em>
</div>
<div class="col-md-6"><p>Provide an object for the specified interface or class name.</p></div>
</div>
<div class="row">
<div class="col-md-6">
<em><a href="../Consolidation/AnnotatedCommand/State.html"><abbr title="Consolidation\AnnotatedCommand\State">State</abbr></a></em>
</div>
<div class="col-md-6"></div>
</div>
</div>


</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>

</html>
Loading

0 comments on commit 18f51c7

Please sign in to comment.