nasldoc 0.1.0 → 0.1.1

data/lib/nasldoc/cli/comment.rb

@@ -0,0 +1,317 @@
+# Copyright (c) 2011-2013 Tenable Network Security.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     * Redistributions of source code must retain the above copyright
+#	notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#	notice, this list of conditions and the following disclaimer in the
+#	documentation and/or other materials provided with the distribution.
+#     * Neither the name of the Tenable Network Security nor the names of its contributors
+#	may be used to endorse or promote products derived from this software
+#	without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL TENABLE NETWORK SECURITY BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module NaslDoc
+	module CLI
+		class CommentException < Exception
+		end
+
+		class DuplicateArgumentException < CommentException
+		end
+
+		class DuplicateTagException < CommentException
+		end
+
+		class TagFormatException < CommentException
+		end
+
+		class UnrecognizedTagException < CommentException
+		end
+
+		class UnsupportedClassException < CommentException
+		end
+
+		class Comment
+			# Common attributes.
+			attr_reader :name, :type, :valid
+
+			# Freeform text attributes.
+			attr_accessor :description, :summary
+
+			# Tag attributes.
+			attr_accessor :anonparams, :categories, :deprecated, :includes, :nessus
+			attr_accessor :params, :remarks, :return
+
+			# Export and function attributes.
+			attr_accessor :function
+
+			# File attributes.
+			attr_accessor :filename, :signed
+
+			# Global attributes.
+			attr_accessor :variables
+
+			@@tags = [
+				'anonparam',
+				'category',
+				'deprecated',
+				'include',
+				'nessus',
+				'param',
+				'remark',
+				'return'
+			]
+
+			def initialize(node, path)
+				# Create common attributes.
+				@name = nil
+				@type = nil
+				@valid = false
+
+				# Create freeform text attributes.
+				@summary = nil
+				@description = nil
+
+				# Create tag attributes.
+				@anonparams = {}
+				@categories = []
+				@deprecated = nil
+				@includes = []
+				@nessus = nil
+				@params = {}
+				@remarks = []
+				@return = nil
+
+				# Create export and function attributes.
+				@function = nil
+
+				# Create file attributes.
+				@filename = nil
+				@signed = nil
+
+				# Create global attributes.
+				@variables = []
+
+				# Determine if this is a nasldoc comment.
+				text = node.text.body;
+				@valid = !Regexp.new("(^\s*\#{2,3}\s*$|#{trusted_regex})").match(text).nil?
+				return unless @valid
+
+				# Remember the type.
+				unless node.next.nil?
+					@type = node.next.class.name.gsub(/.*::/, '').downcase.to_sym
+				else
+					# The first comment in a file might not have a next node.
+					@type = :file
+				end
+
+				# Store any other attributes we may need, since we're not keeping a
+				# reference to the node.
+				case @type
+				when :export
+					extract_function(node.function)
+				when :file
+					extract_file(node, path)
+				when :function
+					extract_function(node)
+				when :global
+					extract_global(node)
+				else
+					raise UnsupportedClassException, "The class #{node.next.class.name} is not supported."
+				end
+
+				# Parse the comment's text.
+				parse(text)
+			end
+
+			def parse(text)
+				# Remove the trusted header.
+				re_sig = Regexp.new(trusted_regex)
+				text.gsub!(re_sig, '');
+
+				# Remove the comment prefixes ('#') from the text.
+				text.gsub!(/^#+/, '');
+
+				# Parse all the paragraphs of free-form text.
+				parse_paragraphs(text)
+
+				# Parse all the tags.
+				parse_tags(text)
+			end
+
+			def parse_paragraphs(text)
+				re_none = Regexp.new(/[^[:space:]]/)
+				re_tags = Regexp.new(tags_regex)
+
+				# Collect together a list of paragraphs.
+				min = 9999
+				paras = []
+				text.each_line('') do |para|
+					# Skip if the paragraph has a line starting with a tag, or has no
+					# content.
+					next unless para =~ re_none
+					next if para =~ re_tags
+					para.rstrip!
+					paras << para
+
+					# Determine the minimum indentation across all paragraphs.
+					para.each_line do |line|
+						padding = line[/^ */]
+						min = [min, padding.length].min
+
+						# No point in continuing if we hit the lower bound.
+						break if min == 0
+					end
+				end
+
+				# Strip the minimum number of spaces from the left.
+				if min > 0
+					regex = Regexp.new("^ {#{min}}")
+					paras.map! { |p| p.gsub(regex, '') }
+				end
+
+				# The first paragraph is the summary.
+				@summary = paras.shift
+
+				# The following paragraphs are the description.
+				@description = paras
+			end
+
+			def parse_tags(text)
+				re_name = Regexp.new("[_a-zA-Z][_a-zA-Z0-9]*")
+				re_tags = Regexp.new(tags_regex)
+
+				# Tags start a line which continues until the next tag or blank line.
+				text.each_line('') do |para|
+					# Skip if the paragraph it doesn't have a line starting with a tag.
+					next if para !~ re_tags
+
+					# Break the paragraphs into blocks, each starting with a tag.
+					until para.empty?
+						# Find the bounds of the block.
+						beg = para.index(re_tags)
+						break if beg.nil?
+						fin = para.index(re_tags, beg + 1) || -1
+
+						# Pull the block out of the paragraph.
+						block = para[beg..fin]
+						para = para[fin..-1]
+
+						# Remove the tag from the block.
+						tag = block[re_tags]
+						block = block[tag.length..-1]
+						next if block.nil?
+
+						# Squash all spaces on the block, being mindful that if the block is
+						# nil the tag is useless.
+						block.gsub!(/[ \n\r\t]+/, ' ')
+						next if block.nil?
+						block.strip!
+						next if block.nil?
+
+						# Squash the tag and trim the '@' off for accessing the object's
+						# attribute.
+						tag.lstrip!
+						attr = tag[1..-1]
+
+						case tag
+							when '@anonparam', '@param'
+								# Parse the argument name.
+								name = block[re_name]
+								if name.nil?
+									raise TagFormatException, "Failed to parse the #{tag}'s name for #@name."
+								end
+
+								block = block[name.length..-1]
+								if block.nil?
+									raise TagFormatException, "Failed to parse the #{tag}'s block for #@name."
+								end
+								block.lstrip!
+
+								# Check for previous declarations of this name.
+								if @anonparams.key?(name)
+									raise DuplicateTagException, "The param '#{name}' was previously declared as an @anonparam for #@name."
+								end
+
+								if @params.key?(name) and not @params[name].nil?
+									raise DuplicateTagException, "The param '#{name}' was previously declared as a @param for #@name."
+								end
+
+								hash = self.send(attr + 's')
+								hash[name] = block
+							when '@category'
+								unless @categories.empty?
+									raise DuplicateTagException, "The #{tag} tag appears more than once for #@name."
+								end
+
+								@categories = block.split(/,/).map &:strip
+							when '@deprecated', '@nessus', '@return'
+								unless self.send(attr).nil?
+									raise DuplicateTagException, "The #{tag} tag appears more than once for #@name."
+								end
+
+								self.send(attr + '=', block)
+							when '@include', '@remark'
+								self.send(attr + 's').push(block)
+							else
+								raise UnrecognizedTagException, "The #{tag} tag is not recognized in #@name."
+						end
+					end
+				end
+			end
+
+			def tags_regex
+				"^\s*@(#{@@tags.join('|')})"
+			end
+
+			def trusted_regex
+				"^#TRUSTED [[:xdigit:]]{1024}$"
+			end
+
+			def extract_file(node, path)
+				# Remember the filename.
+				@filename = File.basename(path)
+
+				# Name this comment for use in error messages.
+				@name = "file #@filename"
+
+				# Determine whether the filename is signed, but don't validate the
+				# signature.
+				@signed = !Regexp.new(trusted_regex).match(node.text.body).nil?
+			end
+
+			def extract_function(node)
+				# Remember the function name.
+				fn = node.next
+				@function = fn.name.name
+
+				# Name this comment for use in error messages.
+				@name = "function #@function"
+
+				# Add in all named parameters, even ones that weren't annotated.
+				fn.params.each { |arg| @params[arg.name] = nil }
+			end
+
+			def extract_global(node)
+				# Remember all the variables.
+				@variables = node.next.idents.map &:name
+
+				# Name this comment for use in error messages.
+				@name = "global variable(s) #{@variables.join(', ')}"
+			end
+		end
+	end
+end

data/lib/nasldoc/templates/file.erb

@@ -1,159 +1,367 @@
-<html>
-	<head>
-		<title><%= @current_file %></title>
-		<link rel = 'stylesheet' type= 'text/css' href='stylesheet.css'>
-	</head>
-	<body>
-		<div id='content'>
-			<a name='top'></a>
-			<h1><%= @current_file %> Overview</h1>
-			<% if @overview.size != 0 %>
-				<p><%= @overview %></p>
-			<% end %>
-      
-      <br />
-
-			<% if @includes.size != 0 %>
-			<h1>Defined Includes</h1>
-				<ul>
-					<% @includes.each do |i| %>
-						<li><a href="<%= i['file'].first.gsub('.', '_') %>.html"><%= i['file'].first %></a></li>
-					<% end %>
-				</ul>
-			<% end %>
-			
-			<% if @overview_includes.size != 0 %>
-			<h1>Required Includes</h1>
-				<ul>
-					<% @overview_includes.each do |i| %>
-						<li><a href="<%= i.gsub('.', '_') %>.html"><%= i %></a></li>
-					<% end %>
-				</ul>
+<%
+  def comment(name, type)
+	filter1 = proc { |c| c.type == type }
+
+	filter2 = case type
+	when :export, :function
+	  Proc.new { |c| c.function == name }
+	when :file
+	  Proc.new { |c| true }
+	when :global
+	  Proc.new { |c| c.variables.include? name }
+	end
+
+	@comments.select(&filter1).select(&filter2).shift
+  end
+%>
+
+<%
+  def safe(obj, default, *attrs)
+	attrs.each do |attr|
+	  return default unless obj.respond_to? attr
+	  obj = obj.send(attr)
+	end
+
+	obj
+  end
+%>
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+  <meta charset="utf-8">
+  <title>nasldoc: nasl</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="description" content="">
+  <meta name="author" content="">
+
+  <!-- Le styles -->
+  <style type="text/css">
+	body {
+	padding-top: 60px;
+	padding-bottom: 40px;
+	}
+	.sidebar-nav {
+	padding: 9px 0;
+	}
+  </style>
+
+  <link href="css/bootstrap.min.css" rel="stylesheet">
+  <link href="css/shCore.css" rel="stylesheet" type="text/css" />
+  <link href="css/shThemeDefault.css" rel="stylesheet" type="text/css" />
+
+  <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+	<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+
+  <!-- Fav and touch icons -->
+  <link rel="shortcut icon" href="ico/favicon.ico">
+  <link rel="apple-touch-icon-precomposed" sizes="144x144" href="ico/apple-touch-icon-144-precomposed.png">
+  <link rel="apple-touch-icon-precomposed" sizes="114x114" href="ico/apple-touch-icon-114-precomposed.png">
+  <link rel="apple-touch-icon-precomposed" sizes="72x72" href="ico/apple-touch-icon-72-precomposed.png">
+  <link rel="apple-touch-icon-precomposed" href="ico/apple-touch-icon-57-precomposed.png">
+  </head>
+
+  <body>
+
+	<div class="navbar navbar-inverse navbar-fixed-top">
+	  <div class="navbar-inner">
+		<div class="container-fluid">
+		  <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+			<span class="icon-bar"></span>
+			<span class="icon-bar"></span>
+			<span class="icon-bar"></span>
+		  </a>
+		  <a class="brand" href="index.html">nasldoc</a>
+		  <div class="nav-collapse collapse">
+			<ul class="nav">
+			  <li class="active"><a href="index.html">Home</a></li>
+			</ul>
+		  </div><!--/.nav-collapse -->
+		</div>
+	  </div>
+	</div>
+
+  <div class="container-fluid">
+	<div class="row-fluid">
+	<div class="span3">
+	  <div class="well sidebar-nav">
+	  <ul class="nav nav-list">
+		<% @file_list.each_with_index do |file, i| %>
+			<% row = i.even? ? 'even' : 'odd' %>
+			<% link = url(file) %>
+			<li class="<%= row %>">
+			  <a href="<%= link %>"><%= link.gsub('.html', '.inc') %></a>
+			</li>
+		<% end %>
+	  </ul>
+	  </div><!--/.well -->
+	</div><!--/span-->
+	<div class="span9">
+
+		<a name="top"></a>
+		<h1>Overview of <%= @current_file %></h1>
+		<% unless @overview.nil? %>
+		<% unless @overview.summary.nil? %>
+		<p class="summary"><%= @overview.summary %></p>
+		<% end %>
+		<% @overview.description.each do |paragraph| %>
+		<p class="description"><%= paragraph %></p>
+		<% end %>
+
+		<% if @overview.signed %>
+			<h1>Signed</h1>
+			<p>This library contains a signature, indicating that it is permitted to
+			call trusted builtin functions.</p>
+			<p class="warning">The signature on this library has not been checked, so
+			there is no guarantee it will run in Nessus.</p>
+		<% end %>
+
+		<% unless @overview.includes.empty? %>
+
+		<h1>Required Includes</h1>
+		<p>These files must be included by the importing code.</p>
+		<ul>
+		  <% @overview.includes.sort.each do |inc| %>
+		  <li><a href="<%= url(inc) %>"><%= inc %></a></li>
+		  <% end %>
+		</ul>
+		<% end %>
+		<% end %>
+
+		<% unless @includes.empty? %>
+
+		<h1>Automatic Includes</h1>
+		<p>These files are automatically included by the library.</p>
+		<ul>
+		  <% @includes.each do |inc| %>
+		  <li><a href="<%= url(inc) %>"><%= inc %></a></li>
+		  <% end %>
+		</ul>
+		<% end %>
+
+		<% {Public: @globs_pub, Private: @globs_prv}.each do |name, list| %>
+		<% unless list.empty? %>
+
+		<h1><%= name %> Variable Summary</h1>
+
+		<% if name == :Public %>
+		<p>Public variables are intended to be accessed by the code that imports
+		this library.</p>
+		<% else %>
+		<p>Private variables are not intended to be accessed by the code that
+		imports this library. There is no functional difference between private
+		and public variables, only convention, and they may be accessed as
+		normal. </p>
+		<% end %>
+
+		<table class="nopad">
+		  <tr class="TableHeadingColor">
+			<th>Name</th>
+			<th>Summary</th>
+		  </tr>
+		  <% list.each do |name| %>
+		  <tr>
+			<td><a href="#<%= name %>"><%= name %></a></td>
+			<td><%= safe(comment(name, :global), "", :summary) %></td>
+		  </tr>
+		  <% end %>
+		</table>
+		<% end %>
+		<% end %>
+
+		<% {Public: @funcs_pub, Private: @funcs_prv}.each do |name, list| %>
+		<% unless list.empty? %>
+		<h1><%= name %> Function Summary</h1>
+
+		<% if name == :Public %>
+		<p>Public functions are intended to be called by the code that imports
+		this library.</p>
+		<% else %>
+		<p>Private functions are not intended to be called by the code that
+		imports this library. There is no functional difference between private
+		and public functions, only convention, and they may be called as
+		normal. </p>
+		<% end %>
+
+		<table class="nopad">
+		  <tr class="TableHeadingColor">
+			<th>Name</th>
+			<th>Summary</th>
+		  </tr>
+		  <% list.keys.sort.each do |name| %>
+		  <tr>
+			<td><a href="#<%= name %>"><%= name %></a></td>
+			<td><%= safe(comment(name, :function), "", :summary) %></td>
+		  </tr>
+		  <% end %>
+		</table>
+		<% end %>
+		<% end %>
+
+		<% {Public: @globs_pub, Private: @globs_prv}.each do |name, list| %>
+		<% unless list.empty? %>
+		<h1><%= name %> Variable Details</h1>
+		<% list.each do |name| %>
+		<h2 id="<%= name %>"><%= name %></h2>
+		<% comm = comment(name, :global) %>
+
+		<% unless comm.nil? %>
+		<% unless comm.summary.nil? %>
+
+		<h3>Summary</h3>
+		<p class="summary"><%= comm.summary %></p>
+		<% end %>
+
+		<% unless comm.description.empty? %>
+		<h3>Description</h3>
+			<% comm.description.each do |para| %>
+				<p class="description"><%= para %></p>
 			<% end %>
-			
-			<table class="nopad">
-				<tr class='TableHeadingColor'>
-					<td>
-						<h1>Function Summary</h1>
-					</td>
-				</tr>
-				
-				<% argz = "" %>
-				<% @functions.each do |function| %>
-				<tr>
-					<td>
-						<% argz = function["args"] %>
-										
-						<% if function["anon_params"].size != 0 %>
-							<% function["anon_params"].each do |k,v| %>
-								<% if argz.length > 0 %>
-									<% argz << ", " %>
-								<% end %>
-								<% argz << "<i>#{k}</i>" %>
-							<% end %>
-						<% else %>
-							<% argz = function["args"] %>
-						<% end %>
-						
-						<code><a href='#<%= function["name"] %>'><%= function["name"]%>(<%= argz %>)</a></code>
-						<% summary = function['summary'].split("<br />") %>						
-
-						<% if summary[0] != "" %>
-							<% summary = summary[0] %>
-						<% elsif summary[1] != "" %>
-							<% summary = summary[1] %>
-						<% end %>
-
-						<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<%= summary %>
-					</td>
-				</tr>
-				<% end %>
-			</table>
-			
-			<h1>Function Details</h1>
-
-			<% @functions.each do |function| %>
-				<% argz = String.new %>
-				<% argz = function["args"] %>
-				<% if function["anon_params"].size != 0 %>
-					<% function["anon_params"].each do |k,v| %>
-						<% argz << ", <i>#{k}</i>" unless argz.include?(k) %>
-					<% end %>
-				<% else %>
-					<% argz = function["args"] %>
-				<% end %>
-			
-				<h2><a name='<%= function["name"] %>'><%= function["name"]%></a></h2>
-				<pre><b><%= function["name"]%> (<%= argz %>)</b></pre>
-				<p><%= function["summary"]%></p>
-											
-				<% if function["params"].size != 0 %>
-					<h3>Named Parameters:</h3>
-					<ul>
-					<% function["params"].each do |k,v| %>
-						<li><code><%= k %></code> - <%= v %></li>
-					<% end %>
-					</ul>
-				<% end %>
-							
-				<% if function["anon_params"].size != 0 %>
-					<h3>Anonymous Parameters:</h3>
-					<ul>
-					<% function["anon_params"].each do |k,v| %>
-						<li><code><%= k %></code> - <%= v %></li>
-					<% end %>
-					</ul>
-				<% end %>
-				
-				<% if function["deprecated"].size != 0 %>
-					<h3>Deprecated:</h3>
-					<ul>
-					<% function["deprecated"].each do |k,v| %>
-						<li><%= k %></li>
-					<% end %>
-					</ul>
-				<% end %>
-				
-				<% if function["category"].size != 0 %>
-					<h3>Function Category:</h3>
-					<ul>
-					<% function["category"].each do |k,v| %>
-						<li><code><%= k %></code></li>
-					<% end %>
-					</ul>
-				<% end %>
-				
-				<% if function["remark"].size != 0 %>
-					<h3>Function Remarks:</h3>
-					<ul>
-					<% function["remark"].each do |k,v| %>
-						<li><code><%= k %></code></li>
-					<% end %>
-					</ul>
-				<% end %>
-				
-				<% if function["nessus"].size != 0 %>
-					<h3>Nessus Version Required:</h3>
-					<ul>
-					<% function["nessus"].each do |k,v| %>
-						<li><code><%= k %></code></li>
-					<% end %>
-					</ul>
-				<% end %>
-				
-				<% if function["returns"].size != 0 %>
-					<h3>Returns:</h3>
-					<ul>
-					<% function["returns"].each do |k,v| %>
-						<li><%= v %></li>
-					<% end %>
-					</ul>
+		<% end %>
+
+		<% unless comm.remarks.empty? %>
+			<h3>Remarks</h3>
+				<% comm.remarks.each do |rem| %>
+					<p class="remark"><%= rem %></p>
 				<% end %>
-				
-				<a href='#top'>top</a>
+		<% end %>
+
+		<% unless comm.deprecated.nil? %>
+			<h3>Deprecated</h3>
+			<p class="deprecated"><%= comm.deprecated %></p>
+		<% end %>
 
-				<hr>
+		<% unless comm.nessus.nil? %>
+			<h3>Nessus Version</h3>
+			<p class="nessus"><%= comm.nessus %></p>
+		<% end %>
+
+		<% unless comm.categories.empty? %>
+			<h3>Categories</h3>
+			<ul>
+				<% comm.categories.sort.each do |cat| %>
+					<li><%= cat %></li>
+				<% end %>
+			</ul>
 			<% end %>
-		</div>
-	</body>
+		<% end %>
+
+		<a href="#top">top</a>
+		<hr>
+		<% end %>
+		<% end %>
+		<% end %>
+
+		<% {Public: @funcs_pub, Private: @funcs_prv}.each do |name, list| %>
+		<% unless list.empty? %>
+		<h1><%= name %> Function Details</h1>
+		<% list.keys.sort.each do |name| %>
+		<h2 id="<%= name %>"><%= name %></h2>
+		<% comm = comment(name, :function) %>
+
+		<% unless comm.nil? %>
+		<% unless comm.summary.nil? %>
+		<h3>Summary</h3>
+		<p class="summary"><%= comm.summary %></p>
+		<% end %>
+
+		<% unless comm.description.empty? %>
+		<h3>Description</h3>
+		<% comm.description.each do |para| %>
+		<p class="description"><%= para %></p>
+		<% end %>
+		<% end %>
+
+		<% unless comm.remarks.empty? %>
+		<h3>Remarks</h3>
+		<% comm.remarks.each do |rem| %>
+		<p class="remark"><%= rem %></p>
+		<% end %>
+		<% end %>
+
+		<% unless comm.deprecated.nil? %>
+		<h3>Deprecated</h3>
+		<p class="deprecated"><%= comm.deprecated %></p>
+		<% end %>
+
+		<% unless comm.nessus.nil? %>
+		<h3>Nessus Version</h3>
+		<p class="nessus"><%= comm.nessus %></p>
+		<% end %>
+
+		<% unless comm.categories.empty? %>
+		<h3>Categories</h3>
+		<ul>
+		<% comm.categories.sort.each do |cat| %>
+		<li><%= cat %></li>
+		<% end %>
+		</ul>
+		<% end %>
+
+		<% unless comm.anonparams.empty? %>
+		<h3>Anonymous Parameters</h3>
+		<dl>
+		<% comm.anonparams.sort.each do |name, block| %>
+		  <dt><%= name %></dt>
+		  <dd><%= block %></dd>
+		<% end %>
+		</dl>
+		<% end %>
+		<% end %>
+
+		<% unless @functions[name].nil? || @functions[name].empty? %>
+		<h3>Named Parameters</h3>
+		<dl>
+		<% @functions[name][:params].sort.each do |name| %>
+		  <dt><%= name %></dt>
+		  <% unless comm.nil? || !comm.params.has_key?(name) %>
+		  <dd><%= comm.params[name] %></dd>
+		  <% end %>
+		<% end %>
+		</dl>
+		<% end %>
+
+		<% unless comm.nil? || comm.return.nil? %>
+		<h3>Return Value</h3>
+		<p class="return"><%= comm.return %></p>
+		<% end %>
+
+		<h3>Code</h3>
+		<pre class="brush: nasl">
+		<%= @functions[name][:code] %>
+		</pre>
+		<a href="#top">top</a>
+		<hr>
+		<% end %>
+		<% end %>
+		<% end %>
+
+	</div><!--/span-->
+	</div><!--/row-->
+
+	<hr>
+
+	<footer>
+		<p>&copy; Tenable Network Security 2013</p>
+	</footer>
+
+  </div><!--/.fluid-container-->
+
+  <!-- Le javascript
+  ================================================== -->
+  <!-- Placed at the end of the document so the pages load faster -->
+  <script type="text/javascript" src="js/jquery-1.8.2.js"></script>
+  <script type="text/javascript" src="js/bootstrap.min.js"></script>
+  <script type="text/javascript" src="js/shCore.js"></script>
+  <script type="text/javascript" src="js/shBrushNasl.js"></script>
+
+  <script type="text/javascript">
+    SyntaxHighlighter.defaults['collapse'] = true;
+    SyntaxHighlighter.defaults['gutter'] = false;
+    SyntaxHighlighter.all();
+  </script>
+
+  </body>
 </html>