DARNOLD / Pod-Classdoc-1.01 / classdocs / Pod / Classdoc / Project.pod.html 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
	
<link rel="stylesheet" type="text/css" href="../../podstyle.css" /><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <script type="text/javascript">

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;

    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  </script></head>
<body>
<div class="box">
  <h1 class="t1">Pod::Classdoc</h1>
  <table>
    <tr>
      <td class="label">Description</td>
      <td class="cell">Generate merged project documentation</td>
    </tr>
  </table>
</div>

<div>

</div>


<div class="pod">


<h1 id="NAME">NAME </h1>

<p>Pod::Classdoc::Project - generate POD, classdocs, and folded source with tree TOC</p>

<h1 id="SYNOPSIS">SYNOPSIS </h1>

<pre>	use Pod::Classdoc::Project;

	renderProject(
		Additions	=&gt; $additions,
	    Charset		=&gt; $charset,
	    CloseImage	=&gt; $closeimg,
		Comments	=&gt; !$nocomments,
	    Description	=&gt; $desc,
	    Download	=&gt; $download,
	    Expandable  =&gt; $noexpand,
	    Force		=&gt; $forcegen,
	    Heredoc   	=&gt; !$noheredocs,
	    Imports		=&gt; !$noimports,
	    IconPath	=&gt; $imgpath,
	    JSPath		=&gt; $jspath,
	    Language	=&gt; $lang,
	    Libs		=&gt; \@sources,
	    MinLines	=&gt; $lines,
	    NoIcons		=&gt; $noicons,
	    NoSource	=&gt; $nosrc,
	    OpenImage	=&gt; $openimg,
	    Order		=&gt; \@order,
	    Output		=&gt; $out,
	    POD			=&gt; !$nopod,
	    RootImage	=&gt; $rootimg,
	    CSSPath		=&gt; $csspath,
	    Title		=&gt; $title,
	    Verbose		=&gt; $verbose,
	);

</pre><h1 id="DESCRIPTION">DESCRIPTION </h1>

<p>Generates merged <a href="http://search.cpan.org/perldoc?Pod%3A%3AProjectDocs">Pod::ProjectDocs</a> (for POD), <a href="../Classdoc.pm.html">Pod::Classdoc</a> (for classdocs), and 
<a href="http://search.cpan.org/perldoc?PPI%3A%3AHTML%3A%3ACodeFolder">PPI::HTML::CodeFolder</a> (for source code) output with a Javascript tree widget index
generated by <a href="http://search.cpan.org/perldoc?HTML%3A%3AListToTree">HTML::ListToTree</a>.</p>

<h1 id="METHODS">METHODS </h1>

<p>Refer to included classdocs.</p>

<h1 id="NOTES">NOTES </h1>

<p>By convention, Pod::Classdoc::Project assumes POD for manual pages
is in a separate '.pod' file, <strong>not</strong> embedded in the module
source '.pm' file. POD within '.pm' files is assumed to be
classdocs only.</p>

<h1 id="SEE_ALSO">SEE ALSO </h1>

<p><a href="http://search.cpan.org/perldoc?mkprojdocs">mkprojdocs</a></p>

<p><a href="http://search.cpan.org/perldoc?Pod%3A%3AProjectDocs">Pod::ProjectDocs</a></p>

<p><a href="../Classdoc.pm.html">Pod::Classdoc</a></p>

<p><a href="http://search.cpan.org/perldoc?PPI%3A%3AHTML%3A%3ACodeFolder">PPI::HTML::CodeFolder</a></p>

<p><a href="http://search.cpan.org/perldoc?HTML%3A%3AListToTree">HTML::ListToTree</a></p>

<h1 id="AUTHOR">AUTHOR </h1>

<p>Dean Arnold <a href="mailto:darnold@presicient.com">mailto:darnold@presicient.com</a></p>

<h1 id="COPYRIGHT_AND_LICENSE">COPYRIGHT AND LICENSE </h1>

<p>Copyright(C) 2007, Dean Arnold, USA. All rights reserved.</p>

<p>Permission is granted to use this software under the same terms as Perl itself.
Refer to the <a href="http://search.cpan.org/perldoc?perlartistic">Perl Artistic License</a> for details.</p>


</div><div class="footer">generated by <a href="http://search.cpan.org/perldoc?Pod%3A%3AProjectDocs">Pod::ProjectDocs</a></div></body>
</html>