developers/org.eclipse.ease.helpgenerator/resources/expected_module_org.eclipse.ease.helpgenerator.testproject.module1.html - ease/org.eclipse.ease.core - Git at Google

 <html>
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
 	<link rel="stylesheet" type="text/css" href="../../org.eclipse.ease.help/help/css/modules_reference.css" />
 </head>
 <body>
 	<div class="module" title="Valid Test Module Module">
 		<h1>Valid Test Module Module</h1>
 		<p class="description">This is a test module.</p>

 	</div>

 	<h2>Constants</h2>
 	<table class="constants">
 		<tr>
 			<th>Constant</th>
 			<th>Description</th>
 		</tr>
 		<tr>
  <td><a id="DEFINED_IN_BASE_CLASS">DEFINED_IN_BASE_CLASS</a></td>
  <td class="description" data-field="DEFINED_IN_BASE_CLASS">Constant defined in the base class.</td>
  </tr>
 		<tr>
  <td><a id="INTERFACE_CONSTANT">INTERFACE_CONSTANT</a></td>
  <td class="description" data-field="INTERFACE_CONSTANT">Constant defined in InterfaceA.</td>
  </tr>
 		<tr>
  <td><a id="OLD_VALUE" class="deprecatedText">OLD_VALUE</a></td>
  <td>Some old stuff. <div class="warning"><b>Deprecation warning:</b> we do not need this anymore</div></td>
  </tr>
 		<tr>
  <td><a id="UNIVERSAL_TRUTH">UNIVERSAL_TRUTH</a></td>
  <td class="description" data-field="UNIVERSAL_TRUTH">The answer to all your questions. This is really it.</td>
  </tr>
 	</table>


 	<h2>Method Overview</h2>
 	<table class="functions">
 		<tr>
 			<th>Method</th>
 			<th>Description</th>
 		</tr>
 		<tr>
 			<td><a href="#abstractMethodToBeOverridden">abstractMethodToBeOverridden</a>()</td>
 			<td>Abstract method with documentation in base class.</td>
 		</tr>
 		<tr>
 			<td><a href="#baseParameters">baseParameters</a>()</td>
 			<td>Method with parameters.</td>
 		</tr>
 		<tr>
 			<td><a href="#interfaceAMethod">interfaceAMethod</a>()</td>
 			<td>Method documented in InterfaceA only.</td>
 		</tr>
 		<tr>
 			<td><a href="#interfaceBMethod">interfaceBMethod</a>()</td>
 			<td>Method B documented in the interface only.</td>
 		</tr>
 		<tr>
 			<td><a href="#methodFromBaseClass">methodFromBaseClass</a>()</td>
 			<td>This method is only defined in the base class.</td>
 		</tr>
 		<tr>
 			<td><a href="#methodToBeOverridden">methodToBeOverridden</a>()</td>
 			<td>Method with documentation in base class.</td>
 		</tr>
 		<tr>
 			<td><a href="#optionalParameters">optionalParameters</a>()</td>
 			<td>Method with optional parameters.</td>
 		</tr>
 		<tr>
 			<td><a href="#pleaseThrow">pleaseThrow</a>()</td>
 			<td>Method that always throws.</td>
 		</tr>
 		<tr>
 			<td><a href="#thisIsAMethodWithALongName">shortName</a>()</td>
 			<td>Alias for <a href="#thisIsAMethodWithALongName">thisIsAMethodWithALongName()</a>.</td>
 		</tr>
 		<tr>
 			<td><a href="#simple">simple</a>()</td>
 			<td>Simple method documentation.</td>
 		</tr>
 		<tr>
 			<td><a href="#thisIsAMethodWithALongName">thisIsAMethodWithALongName</a>()</td>
 			<td>Method with method name alias.</td>
 		</tr>
 		<tr>
 			<td><a href="#thisMethodHasGenericParameters">thisMethodHasGenericParameters</a>()</td>
 			<td>Method that uses generic parameters.</td>
 		</tr>
 	</table>


 	<h2>Methods</h2>
 	<div class="command" data-method="abstractMethodToBeOverridden">
 		<h3><a id="abstractMethodToBeOverridden">abstractMethodToBeOverridden</a></h3>
 		<p class="synopsis">void abstractMethodToBeOverridden()</p>

 		<p class="description">Abstract method with documentation in base class.</p>


 	</div>
 	<div class="command" data-method="baseParameters">
 		<h3><a id="baseParameters">baseParameters</a></h3>
 		<p class="synopsis">int baseParameters(int a, long b, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> data)</p>

 		<p class="description">Method with parameters.</p>

 		<dl class="parameters">
 			<dt>a</dt>
 			<dd class="description" data-parameter="a">integer parameter</dd>
 			<dt>b</dt>
 			<dd class="description" data-parameter="b">parameter of type long</dd>
 			<dt>data</dt>
 			<dd class="description" data-parameter="data">java string</dd>
 		</dl>

 		<p class="return">always 0</p>


 	</div>
 	<div class="command" data-method="interfaceAMethod">
 		<h3><a id="interfaceAMethod">interfaceAMethod</a></h3>
 		<p class="synopsis">void interfaceAMethod()</p>

 		<p class="description">Method documented in InterfaceA only.</p>


 	</div>
 	<div class="command" data-method="interfaceBMethod">
 		<h3><a id="interfaceBMethod">interfaceBMethod</a></h3>
 		<p class="synopsis">void interfaceBMethod()</p>

 		<p class="description">Method B documented in the interface only.</p>


 	</div>
 	<div class="command" data-method="methodFromBaseClass">
 		<h3><a id="methodFromBaseClass">methodFromBaseClass</a></h3>
 		<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> methodFromBaseClass()</p>

 		<p class="description">This method is only defined in the base class.</p>


 		<p class="return">nothing of importance</p>


 	</div>
 	<div class="command" data-method="methodToBeOverridden">
 		<h3><a id="methodToBeOverridden">methodToBeOverridden</a></h3>
 		<p class="synopsis">void methodToBeOverridden()</p>

 		<p class="description">Method with documentation in base class. Method body is implemented in the derived class.</p>


 	</div>
 	<div class="command" data-method="optionalParameters">
 		<h3><a id="optionalParameters">optionalParameters</a></h3>
 		<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> optionalParameters(<a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html'>Thread</a> mandatory, <i>[int optionalDefaultsTo1]</i>, <i>[<a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> optionalDefaultsToNull]</i>)</p>

 		<p class="description">Method with optional parameters.</p>

 		<dl class="parameters">
 			<dt>mandatory</dt>
 			<dd class="description" data-parameter="mandatory">Mandatory parameter,</dd>
 			<dt>optionalDefaultsTo1</dt>
 			<dd class="description" data-parameter="optionalDefaultsTo1">simple integer parameter<span class="optional"><b>Optional:</b> defaults to &lt;<i>1</i>&gt;.</span></dd>
 			<dt>optionalDefaultsToNull</dt>
 			<dd class="description" data-parameter="optionalDefaultsToNull">second optional parameter<span class="optional"><b>Optional:</b> defaults to &lt;<i>null</i>&gt;.</span></dd>
 		</dl>

 		<p class="return">result of the function</p>


 		<dl class="examples">
 			<dt>optionalParameters(new Thread(), 22, "nothing")</dt>
 			<dd class="description">first way to call this method           </dd>
 			<dt>optionalParameters(new Thread())</dt>
 			<dd class="description">using default values for parameter 2 and 3           </dd>
 		</dl>

 	</div>
 	<div class="command" data-method="pleaseThrow">
 		<h3><a id="pleaseThrow">pleaseThrow</a></h3>
 		<p class="synopsis">void pleaseThrow() <a href='https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html'>IOException</a></p>

 		<p class="description">Method that always throws.</p>


 		<dl class="exceptions">
 			<dt><a href='https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html'>IOException</a></dt>
 			<dd class="description" data-exception="java.io.IOException">in any case           </dd>
 		</dl>


 	</div>
 	<div class="command" data-method="simple">
 		<h3><a id="simple">simple</a></h3>
 		<p class="synopsis">void simple()</p>

 		<p class="description">Simple method documentation.</p>


 	</div>
 	<div class="command" data-method="thisIsAMethodWithALongName">
 		<h3><a id="thisIsAMethodWithALongName">thisIsAMethodWithALongName</a></h3>
 		<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> thisIsAMethodWithALongName()</p>

 		<p class="description">Method with method name alias. The documentation to this method is long to make sure it is handled with a line break in the source file. Further it
  contains some valid HTML tags that need to be processed correctly by the doclet.
  <p>
  This is a separate paragraph.
  </p></p>
 		<p class="synonyms"><em>Alias:</em>
  shortName()</p>


 		<p class="return">always <code>null</code></p>


 	</div>
 	<div class="command" data-method="thisMethodHasGenericParameters">
 		<h3><a id="thisMethodHasGenericParameters">thisMethodHasGenericParameters</a></h3>
 		<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> thisMethodHasGenericParameters(<a href='https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html'>Function</a> myFunctionParameter)</p>

 		<p class="description">Method that uses generic parameters.</p>

 		<dl class="parameters">
 			<dt>myFunctionParameter</dt>
 			<dd class="description" data-parameter="myFunctionParameter">A function to execute and whose return value will be returned</dd>
 		</dl>

 		<p class="return">result of the function</p>


 	</div>

 </body>
 </html>
	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
	<link rel="stylesheet" type="text/css" href="../../org.eclipse.ease.help/help/css/modules_reference.css" />
	</head>
	<body>
	<div class="module" title="Valid Test Module Module">
	<h1>Valid Test Module Module</h1>
	<p class="description">This is a test module.</p>

	</div>

	<h2>Constants</h2>
	<table class="constants">
	<tr>
	<th>Constant</th>
	<th>Description</th>
	</tr>
	<tr>
	<td><a id="DEFINED_IN_BASE_CLASS">DEFINED_IN_BASE_CLASS</a></td>
	<td class="description" data-field="DEFINED_IN_BASE_CLASS">Constant defined in the base class.</td>
	</tr>
	<tr>
	<td><a id="INTERFACE_CONSTANT">INTERFACE_CONSTANT</a></td>
	<td class="description" data-field="INTERFACE_CONSTANT">Constant defined in InterfaceA.</td>
	</tr>
	<tr>
	<td><a id="OLD_VALUE" class="deprecatedText">OLD_VALUE</a></td>
	<td>Some old stuff. <div class="warning"><b>Deprecation warning:</b> we do not need this anymore</div></td>
	</tr>
	<tr>
	<td><a id="UNIVERSAL_TRUTH">UNIVERSAL_TRUTH</a></td>
	<td class="description" data-field="UNIVERSAL_TRUTH">The answer to all your questions. This is really it.</td>
	</tr>
	</table>


	<h2>Method Overview</h2>
	<table class="functions">
	<tr>
	<th>Method</th>
	<th>Description</th>
	</tr>
	<tr>
	<td><a href="#abstractMethodToBeOverridden">abstractMethodToBeOverridden</a>()</td>
	<td>Abstract method with documentation in base class.</td>
	</tr>
	<tr>
	<td><a href="#baseParameters">baseParameters</a>()</td>
	<td>Method with parameters.</td>
	</tr>
	<tr>
	<td><a href="#interfaceAMethod">interfaceAMethod</a>()</td>
	<td>Method documented in InterfaceA only.</td>
	</tr>
	<tr>
	<td><a href="#interfaceBMethod">interfaceBMethod</a>()</td>
	<td>Method B documented in the interface only.</td>
	</tr>
	<tr>
	<td><a href="#methodFromBaseClass">methodFromBaseClass</a>()</td>
	<td>This method is only defined in the base class.</td>
	</tr>
	<tr>
	<td><a href="#methodToBeOverridden">methodToBeOverridden</a>()</td>
	<td>Method with documentation in base class.</td>
	</tr>
	<tr>
	<td><a href="#optionalParameters">optionalParameters</a>()</td>
	<td>Method with optional parameters.</td>
	</tr>
	<tr>
	<td><a href="#pleaseThrow">pleaseThrow</a>()</td>
	<td>Method that always throws.</td>
	</tr>
	<tr>
	<td><a href="#thisIsAMethodWithALongName">shortName</a>()</td>
	<td>Alias for <a href="#thisIsAMethodWithALongName">thisIsAMethodWithALongName()</a>.</td>
	</tr>
	<tr>
	<td><a href="#simple">simple</a>()</td>
	<td>Simple method documentation.</td>
	</tr>
	<tr>
	<td><a href="#thisIsAMethodWithALongName">thisIsAMethodWithALongName</a>()</td>
	<td>Method with method name alias.</td>
	</tr>
	<tr>
	<td><a href="#thisMethodHasGenericParameters">thisMethodHasGenericParameters</a>()</td>
	<td>Method that uses generic parameters.</td>
	</tr>
	</table>


	<h2>Methods</h2>
	<div class="command" data-method="abstractMethodToBeOverridden">
	<h3><a id="abstractMethodToBeOverridden">abstractMethodToBeOverridden</a></h3>
	<p class="synopsis">void abstractMethodToBeOverridden()</p>

	<p class="description">Abstract method with documentation in base class.</p>





	</div>
	<div class="command" data-method="baseParameters">
	<h3><a id="baseParameters">baseParameters</a></h3>
	<p class="synopsis">int baseParameters(int a, long b, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> data)</p>

	<p class="description">Method with parameters.</p>

	<dl class="parameters">
	<dt>a</dt>
	<dd class="description" data-parameter="a">integer parameter</dd>
	<dt>b</dt>
	<dd class="description" data-parameter="b">parameter of type long</dd>
	<dt>data</dt>
	<dd class="description" data-parameter="data">java string</dd>
	</dl>

	<p class="return">always 0</p>



	</div>
	<div class="command" data-method="interfaceAMethod">
	<h3><a id="interfaceAMethod">interfaceAMethod</a></h3>
	<p class="synopsis">void interfaceAMethod()</p>

	<p class="description">Method documented in InterfaceA only.</p>





	</div>
	<div class="command" data-method="interfaceBMethod">
	<h3><a id="interfaceBMethod">interfaceBMethod</a></h3>
	<p class="synopsis">void interfaceBMethod()</p>

	<p class="description">Method B documented in the interface only.</p>





	</div>
	<div class="command" data-method="methodFromBaseClass">
	<h3><a id="methodFromBaseClass">methodFromBaseClass</a></h3>
	<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> methodFromBaseClass()</p>

	<p class="description">This method is only defined in the base class.</p>


	<p class="return">nothing of importance</p>



	</div>
	<div class="command" data-method="methodToBeOverridden">
	<h3><a id="methodToBeOverridden">methodToBeOverridden</a></h3>
	<p class="synopsis">void methodToBeOverridden()</p>

	<p class="description">Method with documentation in base class. Method body is implemented in the derived class.</p>





	</div>
	<div class="command" data-method="optionalParameters">
	<h3><a id="optionalParameters">optionalParameters</a></h3>
	<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> optionalParameters(<a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html'>Thread</a> mandatory, <i>[int optionalDefaultsTo1]</i>, <i>[<a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> optionalDefaultsToNull]</i>)</p>

	<p class="description">Method with optional parameters.</p>

	<dl class="parameters">
	<dt>mandatory</dt>
	<dd class="description" data-parameter="mandatory">Mandatory parameter,</dd>
	<dt>optionalDefaultsTo1</dt>
	<dd class="description" data-parameter="optionalDefaultsTo1">simple integer parameter<span class="optional"><b>Optional:</b> defaults to <<i>1</i>>.</span></dd>
	<dt>optionalDefaultsToNull</dt>
	<dd class="description" data-parameter="optionalDefaultsToNull">second optional parameter<span class="optional"><b>Optional:</b> defaults to <<i>null</i>>.</span></dd>
	</dl>

	<p class="return">result of the function</p>


	<dl class="examples">
	<dt>optionalParameters(new Thread(), 22, "nothing")</dt>
	<dd class="description">first way to call this method </dd>
	<dt>optionalParameters(new Thread())</dt>
	<dd class="description">using default values for parameter 2 and 3 </dd>
	</dl>

	</div>
	<div class="command" data-method="pleaseThrow">
	<h3><a id="pleaseThrow">pleaseThrow</a></h3>
	<p class="synopsis">void pleaseThrow() <a href='https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html'>IOException</a></p>

	<p class="description">Method that always throws.</p>



	<dl class="exceptions">
	<dt><a href='https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html'>IOException</a></dt>
	<dd class="description" data-exception="java.io.IOException">in any case </dd>
	</dl>


	</div>
	<div class="command" data-method="simple">
	<h3><a id="simple">simple</a></h3>
	<p class="synopsis">void simple()</p>

	<p class="description">Simple method documentation.</p>





	</div>
	<div class="command" data-method="thisIsAMethodWithALongName">
	<h3><a id="thisIsAMethodWithALongName">thisIsAMethodWithALongName</a></h3>
	<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> thisIsAMethodWithALongName()</p>

	<p class="description">Method with method name alias. The documentation to this method is long to make sure it is handled with a line break in the source file. Further it
	contains some valid HTML tags that need to be processed correctly by the doclet.
	<p>
	This is a separate paragraph.
	</p></p>
	<p class="synonyms"><em>Alias:</em>
	shortName()</p>


	<p class="return">always <code>null</code></p>



	</div>
	<div class="command" data-method="thisMethodHasGenericParameters">
	<h3><a id="thisMethodHasGenericParameters">thisMethodHasGenericParameters</a></h3>
	<p class="synopsis"><a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> thisMethodHasGenericParameters(<a href='https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html'>Function</a> myFunctionParameter)</p>

	<p class="description">Method that uses generic parameters.</p>

	<dl class="parameters">
	<dt>myFunctionParameter</dt>
	<dd class="description" data-parameter="myFunctionParameter">A function to execute and whose return value will be returned</dd>
	</dl>

	<p class="return">result of the function</p>



	</div>

	</body>
	</html>