Skip to content

Commit

Permalink
[#1298] improve overview page (fix previous commit)
Browse files Browse the repository at this point in the history
  • Loading branch information
@remkop
remkop committed Mar 7, 2022
1 parent beeee82 commit 1ea3e60
Showing 1 changed file with 143 additions and 47 deletions.
190 changes: 143 additions & 47 deletions docs/apidocs-all/overview-summary.html
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Overview (picocli 4.7.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
Expand All @@ -17,40 +27,49 @@
catch(err) {
}
//-->
</script>
var pathtoroot = "./";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li><a href="picocli/package-summary.html">Package</a></li>
<li>Module</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
Expand All @@ -62,45 +81,65 @@
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a name="skip.navbar.top">
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">picocli 4.7.0-SNAPSHOT API</h1>
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<div class="header">
<div class="subTitle">
<div class="block">
Picocli is a framework for creating Java command line applications with almost zero code.</div>
</div>
<p>See: <a href="#overview.description">Description</a></p>
<h1 class="title">picocli 4.7.0-SNAPSHOT API</h1>
</div>
<main role="main">
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="picocli/package-summary.html">picocli</a></td>
<td class="colLast">
<div class="block">Provides classes and interfaces for the main picocli <a href="picocli/CommandLine.html" title="class in picocli">command line parsing</a> and
<a href="picocli/AutoComplete.html" title="class in picocli"><code>autocompletion</code></a> functionality.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="contentContainer"><a name="overview.description">
<!-- -->
</a>
<div class="block"><p>
Picocli is a framework for creating Java command line applications with almost zero code.
</p>
<p>
The project contains multiple modules, but most applications only need a few of them.
The table below shows the JPMS module name and the Maven coordinates for all modules in the project.
</p>
<table border="1">
<caption>Picocli project modules: JPMS module name and their Maven coordinates</caption>
<tr>
<th>JPMS module name</th>
<th>Maven coordinates (without version)</th>
</tr>
<tr>
<td><code>info.picocli</code></td>
<td><code>info.picocli:picocli</code></td>
</tr>
<tr>
<td><code>info.picocli.codegen</code></td>
<td><code>info.picocli:picocli-codegen</code></td>
</tr>
<tr>
<td><code>info.picocli.groovy</code></td>
<td><code>info.picocli:picocli-groovy</code></td>
</tr>
<tr>
<td><code>info.picocli.shell.jline2</code></td>
<td><code>info.picocli:picocli-shell-jline2</code></td>
</tr>
<tr>
<td><code>info.picocli.shell.jline3</code></td>
<td><code>info.picocli:picocli-shell-jline3</code></td>
</tr>
<tr>
<td><code>info.picocli.spring.boot</code></td>
<td><code>info.picocli:picocli-spring-boot-starter</code></td>
</tr>
</table>
<p>
Most application will only need the main <code>picocli</code> module, but
we recommend also <a href="https://picocli.info/#_annotation_processor">configuring</a>
Expand Down Expand Up @@ -129,30 +168,82 @@ <h1 class="title">picocli 4.7.0-SNAPSHOT API</h1>
to be injected with values from Spring's Application Context.
</p></div>
</div>
<div class="contentContainer">
<table class="overviewSummary">
<caption><span>Modules</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Module</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor" id="i0">
<th class="colFirst" scope="row"><a href="info.picocli/module-summary.html">info.picocli</a></th>
<td class="colLast">
<div class="block">Defines API and implementation for parsing command line arguments and creating command line (CLI) applications.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<th class="colFirst" scope="row"><a href="info.picocli.codegen/module-summary.html">info.picocli.codegen</a></th>
<td class="colLast">
<div class="block">Defines a picocli annotation processor API and implementation,
and tools for generating GraalVM configuration files and man-page documentation.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<th class="colFirst" scope="row"><a href="info.picocli.groovy/module-summary.html">info.picocli.groovy</a></th>
<td class="colLast">
<div class="block">Defines API and implementation for building command line (CLI) applications with Groovy scripts.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<th class="colFirst" scope="row"><a href="info.picocli.shell.jline2/module-summary.html">info.picocli.shell.jline2</a></th>
<td class="colLast">
<div class="block">Defines picocli-based implementations of JLine 2 APIs
for building interactive command line (REPL) applications.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<th class="colFirst" scope="row"><a href="info.picocli.shell.jline3/module-summary.html">info.picocli.shell.jline3</a></th>
<td class="colLast">
<div class="block">Defines picocli-based implementations of JLine 3 APIs
for building interactive command line (REPL) applications.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<th class="colFirst" scope="row"><a href="info.picocli.spring.boot/module-summary.html">info.picocli.spring.boot</a></th>
<td class="colLast">
<div class="block">Defines Spring-based implementations of picocli APIs and picocli-based implementations
of Spring APIs for integrating picocli with Spring Boot and Spring Boot AutoConfiguration.</div>
</td>
</tr>
</tbody>
</table>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li><a href="picocli/package-summary.html">Package</a></li>
<li>Module</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
Expand All @@ -170,10 +261,15 @@ <h1 class="title">picocli 4.7.0-SNAPSHOT API</h1>
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a name="skip.navbar.bottom">
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>

0 comments on commit 1ea3e60

Please sign in to comment.