lib/metasploit/credential/version.rb in metasploit-credential-1.0.0.pre.rails.pre.4.0 vs lib/metasploit/credential/version.rb in metasploit-credential-1.0.0

@@ -2,46 +2,59 @@
 #   `metasploit/credential` itself is expected to be loaded.
 module Metasploit
   module Credential
     # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
     module Version
+      #
+      # CONSTANTS
+      #
+
       # The major version number.
       MAJOR = 1
       # The minor version number, scoped to the {MAJOR} version number.
       MINOR = 0
-      # The patch number, scoped to the {MINOR} version number.
+      # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
       PATCH = 0
-      # the prerelease identifier
-      PRERELEASE = 'rails-4.0'
 
-      # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+      #
+      # Module Methods
+      #
+
+      # The full version string, including the {Metasploit::Credential::Version::MAJOR},
+      # {Metasploit::Credential::Version::MINOR}, {Metasploit::Credential::Version::PATCH}, and optionally, the
+      # `Metasploit::Credential::Version::PRERELEASE` in the
       # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
       #
-      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-{PRERELEASE}' on any branch
-      #   other than master.
+      # @return [String] '{Metasploit::Credential::Version::MAJOR}.{Metasploit::Credential::Version::MINOR}.{Metasploit::Credential::Version::PATCH}'
+      #   on master.
+      #   '{Metasploit::Credential::Version::MAJOR}.{Metasploit::Credential::Version::MINOR}.{Metasploit::Credential::Version::PATCH}-PRERELEASE'
+      #   on any branch other than master.
       def self.full
         version = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
         if defined? PRERELEASE
           version = "#{version}-#{PRERELEASE}"
         end
 
         version
       end
 
-      # The full gem version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+      # The full gem version string, including the {Metasploit::Credential::Version::MAJOR},
+      # {Metasploit::Credential::Version::MINOR}, {Metasploit::Credential::Version::PATCH}, and optionally, the
+      # `Metasploit::Credential::Version::PRERELEASE` in the
       # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
       #
-      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
-      #   other than master.
+      # @return [String] '{Metasploit::Credential::Version::MAJOR}.{Metasploit::Credential::Version::MINOR}.{Metasploit::Credential::Version::PATCH}'
+      #   on master.  '{Metasploit::Credential::Version::MAJOR}.{Metasploit::Credential::Version::MINOR}.{Metasploit::Credential::Version::PATCH}.PRERELEASE'
+      #   on any branch other than master.
       def self.gem
         full.gsub('-', '.pre.')
       end
     end
 
-    # @see Version.gem
+    # (see Version.gem)
     GEM_VERSION = Version.gem
 
-    # @see Version.full
+    # (see Version.full)
     VERSION = Version.full
   end
 end