[Abtlinux-svn] SF.net SVN: abtlinux: [176] src/trunk/AbtUsage.rb

[<esc...@us...>]

Revision: 176
          http://svn.sourceforge.net/abtlinux/?rev=176&view=rev
Author:   eschabell
Date:     2006-11-15 03:50:23 -0800 (Wed, 15 Nov 2006)

Log Message:
-----------
Added docs to AbtUsage class.

Modified Paths:
--------------
    src/trunk/AbtUsage.rb

Modified: src/trunk/AbtUsage.rb
===================================================================
--- src/trunk/AbtUsage.rb	2006-11-15 11:06:07 UTC (rev 175)
+++ src/trunk/AbtUsage.rb	2006-11-15 11:50:23 UTC (rev 176)
@@ -26,6 +26,13 @@
 ##
 class AbtUsage
 
+	##
+	# The main usage method, displays either a given section or all sections.
+	#
+	# <b>PARAM</b> <i>String</i> - the name of the help section to be shown.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usage( section )
 		puts "Usage: abt.rb [options]\n\n"
 
@@ -59,8 +66,13 @@
 		end
 	end
 
+	##
+	# The usage information for the packages commands.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usagePackages
-    puts "\npackages:"
+		puts "\npackages:"
 		puts "  -i,  install     [package]\t\tInstall given package."
 		puts "  -ri, reinstall   [package]\t\tReinstall given package."
 		puts "  -r,  remove      [package]\t\tRemove given package."
@@ -68,6 +80,11 @@
 		puts "  -f,  freeze      [package]\t\tHolds given package at current version, prevents upgrades.\n"
 	end
 
+	##
+	# The usage information for the query commands.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usageQueries
 		puts "\nqueries:"
 		puts "  -s,  search      [string | regexp ]\tSearch package descriptions for given input."
@@ -76,7 +93,7 @@
 		puts "  show-depends     [package]\t\tShow the dependency tree of given package."
 		puts "  show-files       [package]\t\tShow all installed files from given package."
 		puts "  show-owner       [file]\t\tShow the package owning given file."
-    puts "  show-installed\t\t\tShow list of all installed packages."
+		puts "  show-installed\t\t\tShow list of all installed packages."
 		puts "  show-frozen\t\t\t\tShow list of all frozen packages."
 		puts "  show-untracked\t\t\tShow all files on system not tracked by AbTLinux."
 		puts "  show-journal\t\t\t\tShow the system journal."
@@ -84,37 +101,57 @@
 		puts "  show-patches\t\t\t\tShow the current available patches for installed package tree.\n"
 	end
 
+	##
+	# The usage information for the generation commands.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usageGeneration
 		puts "\ngeneration:"
 		puts "  show-updates\t\tShow a package listing with available update versions."
 		puts "  html\t\t\tGenerate HTML page from installed packages:"
-    puts "  \t\t\t\t(package name with hyperlink to package website and version installed)\n"
+		puts "  \t\t\t\t(package name with hyperlink to package website and version installed)\n"
 	end
 
+	##
+	# The usage information for the download commands.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usageDownloads
-    puts "\ndownloads:"
-    puts "  -d,  download     [package]\t\tRetrieve given package sources."
-    puts "  -u,  update       [package]|[tree]\tUpdate given package or tree from AbTLinux repository."
-    puts "  -n,  news\t\t\t\tDisplays newsfeed from AbTLinux website.\n"
+		puts "\ndownloads:"
+		puts "  -d,  download     [package]\t\tRetrieve given package sources."
+		puts "  -u,  update       [package]|[tree]\tUpdate given package or tree from AbTLinux repository."
+		puts "  -n,  news\t\t\t\tDisplays newsfeed from AbTLinux website.\n"
 	end
 
+	##
+	# The usage information for the fix commands.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usageFix
-    puts "\nfix:"
-    puts "  purge-src\t\t\t\tRemove source caches for packages no longer installed."
-    puts "  purge-logs\t\t\t\tRemove log files for packages no longer installed."
-    puts "  verify-files      [package]\t\tInstalled files are verified for given package."
-    puts "  verify-symlinks   [package]\t\tSymlinks verified for given package."
-    puts "  verify-deps       [package]\t\tDependency tree is verified for given package."
-    puts "  verify-integrity  [package]\t\tVerify integrity of installed files for given package."
-    puts "  fix               [package]\t\tGiven package is verified and fixed if needed.\n"
+		puts "\nfix:"
+		puts "  purge-src\t\t\t\tRemove source caches for packages no longer installed."
+		puts "  purge-logs\t\t\t\tRemove log files for packages no longer installed."
+		puts "  verify-files      [package]\t\tInstalled files are verified for given package."
+		puts "  verify-symlinks   [package]\t\tSymlinks verified for given package."
+		puts "  verify-deps       [package]\t\tDependency tree is verified for given package."
+		puts "  verify-integrity  [package]\t\tVerify integrity of installed files for given package."
+		puts "  fix               [package]\t\tGiven package is verified and fixed if needed.\n"
 	end
 
+	##
+	# The usage information for the maintenance commands.
+	#
+	# <b>RETURN</b> <i>void</i>
+	##
 	def usageMaintenance
-    puts "\nmaintenance:"
-    puts "  build-location    [host]\t\tSets global location (default: localhost) for retrieving cached package builds."
-    puts "  package-repo      [add|remove|list] [URI]"
-    puts "                                        add    - add package repository to list."
-    puts "                                        remove - remove a package repository from list."
-    puts "                                        list   - display current repository list.\n"
+		puts "\nmaintenance:"
+		puts "  build-location    [host]\t\tSets global location (default: localhost) for retrieving cached package builds."
+		puts "  package-repo      [add|remove|list] [URI]"
+		puts "                                        add    - add package repository to list."
+		puts "                                        remove - remove a package repository from list."
+		puts "                                        list   - display current repository list.\n"
 	end
 end


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.