nasldoc 0.0.8 → 0.0.9

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2011-2012 Jacob Hammack.
+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 Jacob Hammack 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 JACOB HAMMACK 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.

data/NEWS.markdown

@@ -1,5 +1,8 @@
 # News
 
+#0.0.9 (March 2012)
+- Fixed a show stopper
+
 #0.0.8 (July 2011)
 - Open sourced project on github
 - Added daily_badurl.inc to the blacklist

data/README.markdown

@@ -1,17 +1,9 @@
-#Setup
+#Installation
 
-Setting up nasldoc to run is fairly simple. All you really need is the Ruby interpreter.
+Installation is really easy, all you need to do is gem install!
 
-	* [http://www.rubylang.org Ruby Programming Language]
+	% gem install nasldoc
 
-#Development
-
-Before writing nasldoc from scratch I tried to use several different open source solutions.
-
-- jsdoc - This tool was promising but the author hardcoded /** */ as the comment delimiter which causes issues with Nasl since we cannot add a new comment style.
-- javadoc - Parsed out the java language which made it impossible to do Nasl with it
-- phpDocumentor - Worked well on parsing .inc files, but required /** */ comment styles
-- Doxygen - Everything about Doxygen is hardcoded into the source, I wasn't able to change anything to get it to work with Nasl.
 
 #Usage
 
@@ -27,40 +19,32 @@ Nasldoc comments are inclosed in ## blocks and use special tags to mark items, c
 
 Nasldoc supports several markup tags this tags are:
 
-	* @param - used to label named arguments to a function
-	* @anonparam - used to label anonymous arguments to a function
-	* @return - what the function returns
+- @param - used to label named arguments to a function
+- @anonparam - used to label anonymous arguments to a function
+- @return - what the function returns
+- @deprecated
+- @nessus
+- @category
+- @remark
 
-##Function Description Block
+#Function Description Block
 
 The function description block is free form text from the first ## to the first @tag in the nasldoc body, the lines are split on the # and rejoined with spaces.
 
-##Example
+#Example
 
 <pre>
 ## 
-# Builds and sends a MaxDB dbm_version command packet and returns the results.
+# An example addition function in NASL
 #
-# @param socket The socket that the packet will be sent on
+# @param arg1 first number to add
+# @param arg2 second number to add
 #
-# @return An array of hashes for each of the info from the dbm_version command
+# @return The sum of arg1 and arg2
 ##
-function maxdb_version(socket)
+function add(arg1, arg2)
 {
-  local_var version_pkt, data, version;
-  
-  version_pkt = 
-    maxdb_command_pkt() +
-    "dbm_version";
-  
-  version_pkt = insstr(version_pkt, mkdword(strlen(version_pkt)), 0, 3);
-  version_pkt = insstr(version_pkt, mkdword(strlen(version_pkt)), 20, 23);
-
-  send(socket:socket, data:version_pkt);
-  data = maxdb_read_pkt(socket:socket);
-  version = maxdb_parse_version_info(data:data);
-
-  return version;
+  return (arg1 + arg2);
 }
 </pre>
 
@@ -70,8 +54,8 @@ Nasldoc uses the ERB templating engine to make generating the output html dead s
 
 ##Example
 
-<pre>
-<html>
+
+`<html>
 	<head>
 		<title>nasldoc</title>
 		<link rel = 'stylesheet' type= 'text/css' href='stylesheet.css'>
@@ -90,5 +74,5 @@ Nasldoc uses the ERB templating engine to make generating the output html dead s
 		<br><br><br>
 		<ul><a href='overview.html' target='content'>Home</a></ul>
 	</body>
-</html>
-</pre>
+</html>`
+

data/TODO.markdown

@@ -1 +1,2 @@
-
+# Todo
+- create a github page for the project

data/lib/nasldoc/cli/application.rb

@@ -54,12 +54,6 @@ module NaslDoc
 					puts "[*] Processing File: #{file}"
 					@current_file = File.basename(file, ".inc")
 					contents = File.open(file, 'rb') { |f| f.read } unless file == nil
-					
-					##
-					add_nasldoc_stubs contents
-					exit
-					##
-					
 
 					contents = process_file_overview contents
 					process_file_includes contents
@@ -132,11 +126,11 @@ module NaslDoc
 					nasldoc << "#\n"
 					nasldoc << "##\n"
 					nasldoc << "#{function} #{name}#{openpar}#{args}#{closepar}"
-					
+
 					new_file = new_file.gsub(line, nasldoc)
-					
+
 				end
-				
+
 				puts new_file
 			end
 

data/lib/nasldoc.rb

@@ -1,9 +1,10 @@
 module NaslDoc
 	APP_NAME = "nasldoc"
-	VERSION = "0.0.8"
+	VERSION = "0.0.9"
 end
 
 require 'erb'
-require 'nasldoc/cli'
 require 'pathname'
-require 'optparse'
+require 'optparse'
+
+require 'nasldoc/cli'

data/nasldoc.gemspec

@@ -7,7 +7,7 @@ require 'nasldoc'
 Gem::Specification.new do |s|
 	s.name												= "#{NaslDoc::APP_NAME}"
 	s.version											= NaslDoc::VERSION
-	s.homepage										= "https://researchwiki.corp.tenablesecurity.com/index.php/Nasl_doc"
+	s.homepage										= "http://hammackj.com/projects/nasldoc"
 	s.summary											= "#{NaslDoc::APP_NAME}"
 	s.description									= "#{NaslDoc::APP_NAME} is a NASL documentation generator"
 	s.license											= "BSD"

metadata

@@ -1,72 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nasldoc
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.9
   prerelease: 
-  version: 0.0.8
 platform: ruby
-authors: 
+authors:
 - Jacob Hammack
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-14 00:00:00 -05:00
-default_executable: 
+date: 2012-08-24 00:00:00.000000000 Z
 dependencies: []
-
 description: nasldoc is a NASL documentation generator
 email: jhammack@tenable.com
-executables: 
+executables:
 - nasldoc
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
 - NEWS.markdown
 - TODO.markdown
-files: 
-- NEWS.markdown
-- Rakefile
+files:
 - README.markdown
+- LICENSE
+- NEWS.markdown
 - TODO.markdown
-- lib/nasldoc/assets/nessus.jpg
-- lib/nasldoc/assets/stylesheet.css
-- lib/nasldoc/cli/application.rb
-- lib/nasldoc/cli.rb
+- Rakefile
 - lib/nasldoc/templates/file.erb
 - lib/nasldoc/templates/index.erb
-- lib/nasldoc/templates/overview.erb
 - lib/nasldoc/templates/sidebar.erb
+- lib/nasldoc/templates/overview.erb
+- lib/nasldoc/assets/stylesheet.css
+- lib/nasldoc/assets/nessus.jpg
+- lib/nasldoc/cli.rb
+- lib/nasldoc/cli/application.rb
 - lib/nasldoc.rb
 - nasldoc.gemspec
 - bin/nasldoc
-has_rdoc: yard
-homepage: https://researchwiki.corp.tenablesecurity.com/index.php/Nasl_doc
-licenses: 
+homepage: http://hammackj.com/projects/nasldoc
+licenses:
 - BSD
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: nasldoc
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: nasldoc
 test_files: []
-