<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: GLI::Commands::MarkdownDocumentListener
— Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "GLI::Commands::MarkdownDocumentListener";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (M)</a> »
<span class='title'><span class='object_link'><a href="../../GLI.html" title="GLI (module)">GLI</a></span></span> » <span class='title'><span class='object_link'><a href="../Commands.html" title="GLI::Commands (module)">Commands</a></span></span>
»
<span class="title">MarkdownDocumentListener</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: GLI::Commands::MarkdownDocumentListener
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></span>
<ul class="fullTree">
<li><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></li>
<li class="next">GLI::Commands::MarkdownDocumentListener</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/markdown_document_listener.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>DocumentListener class for GLI documentation generator</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#beginning-instance_method" title="#beginning (instance method)">#<strong>beginning</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#command-instance_method" title="#command (instance method)">#<strong>command</strong>(name, aliases, desc, long_desc, arg_name, arg_options) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gives you a command in the current context and creates a new context of this command.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#commands-instance_method" title="#commands (instance method)">#<strong>commands</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_command-instance_method" title="#default_command (instance method)">#<strong>default_command</strong>(name) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gives you the name of the current command in the current context.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#end_command-instance_method" title="#end_command (instance method)">#<strong>end_command</strong>(_name) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Ends a command, and "pops" you back up one context.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#end_commands-instance_method" title="#end_commands (instance method)">#<strong>end_commands</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#end_options-instance_method" title="#end_options (instance method)">#<strong>end_options</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ending-instance_method" title="#ending (instance method)">#<strong>ending</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Called when processing has completed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#flag-instance_method" title="#flag (instance method)">#<strong>flag</strong>(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gives you a flag in the current context.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(_global_options, _options, _arguments, app) ⇒ MarkdownDocumentListener </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of MarkdownDocumentListener.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#program_desc-instance_method" title="#program_desc (instance method)">#<strong>program_desc</strong>(desc) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gives you the program description.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#program_long_desc-instance_method" title="#program_long_desc (instance method)">#<strong>program_long_desc</strong>(desc) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#switch-instance_method" title="#switch (instance method)">#<strong>switch</strong>(name, aliases, desc, long_desc, negatable) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gives you a switch in the current context.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#version-instance_method" title="#version (instance method)">#<strong>version</strong>(version) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gives you the program version.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(_global_options, _options, _arguments, app) ⇒ <tt><span class='object_link'><a href="" title="GLI::Commands::MarkdownDocumentListener (class)">MarkdownDocumentListener</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of MarkdownDocumentListener.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="beginning-instance_method">
#<strong>beginning</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="command-instance_method">
#<strong>command</strong>(name, aliases, desc, long_desc, arg_name, arg_options) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gives you a command in the current context and creates a new context of this command</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="commands-instance_method">
#<strong>commands</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="default_command-instance_method">
#<strong>default_command</strong>(name) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gives you the name of the current command in the current context</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="end_command-instance_method">
#<strong>end_command</strong>(_name) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Ends a command, and "pops" you back up one context</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="end_commands-instance_method">
#<strong>end_commands</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="end_options-instance_method">
#<strong>end_options</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="ending-instance_method">
#<strong>ending</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Called when processing has completed</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="flag-instance_method">
#<strong>flag</strong>(name, aliases, desc, long_desc, default_value, arg_name, must_match, _type) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gives you a flag in the current context</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="options-instance_method">
#<strong>options</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="program_desc-instance_method">
#<strong>program_desc</strong>(desc) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gives you the program description</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="program_long_desc-instance_method">
#<strong>program_long_desc</strong>(desc) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="switch-instance_method">
#<strong>switch</strong>(name, aliases, desc, long_desc, negatable) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gives you a switch in the current context</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="version-instance_method">
#<strong>version</strong>(version) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gives you the program version</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Jul 1 12:43:15 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
</div>
</div>
</body>
</html>