jazzy 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c1b5381e39fcf3979fcdf3f441a9afa3c6346f
-  data.tar.gz: 65736a28e4fc270646fdf7cd9be491953339634e
+  metadata.gz: 549602405c7fd774831d722881c5c8d89696945c
+  data.tar.gz: 02dd41a23da8915336f4e3251f9ba72f9579fe97
 SHA512:
-  metadata.gz: cd122d28d2e16768fe6165f099998c8c1afadcf02798278d00300151762b7b43d4c17ac6f6cf56f553a0cc3cfaf0ae42211bb31d224626096c6b0b66879e03fc
-  data.tar.gz: dd4a094146d32a3a7c61c571ededa504acdaf58df5fcfbc6546321d3291d73d6c997c039d78cb55258e64a35cad0ab5a195720a44ccaf15ba0cd1f576a53cd4d
+  metadata.gz: 58930f702701094f66113af5fe7447737c738ef23a2a57672329ea3c09e600aaacf6ec7e232acf31d3493ca19db72afc4fd9531fac706dd2b84722ddc52ebbf5
+  data.tar.gz: f39d276d4a19aa87de055a5772b8a77f1ceb2ff20da0dce3405b8d0c1a86620db96a7e5153073f4b6c3e8dc708325cadfdfe3338418a96e77ce1565fa096cdee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.0.16)
+    jazzy (0.0.17)
       activesupport (~> 4.1)
       mustache (~> 0.99)
       nokogiri (~> 1.6)
@@ -35,12 +35,12 @@ GEM
     json (1.8.1)
     metaclass (0.0.4)
     mini_portile (0.6.1)
-    minitest (5.4.3)
+    minitest (5.5.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    mustache (0.99.7)
+    mustache (0.99.8)
     nokogiri (1.6.5)
       mini_portile (~> 0.6.0)
     parser (2.2.0.pre.5)
@@ -51,7 +51,7 @@ GEM
       bacon (~> 1.2)
     rainbow (2.0.0)
     rake (10.3.2)
-    redcarpet (3.2.1)
+    redcarpet (3.2.2)
     rouge (1.7.4)
     rubocop (0.26.1)
       astrolabe (~> 1.3)

data/lib/jazzy/config.rb

@@ -1,7 +1,11 @@
 require 'optparse'
 require 'pathname'
+require 'uri'
+
+require 'jazzy/source_declaration/access_control_level'
 
 module Jazzy
+  # rubocop:disable Metrics/ClassLength
   class Config
     attr_accessor :output
     attr_accessor :xcodebuild_arguments
@@ -15,19 +19,20 @@ module Jazzy
     attr_accessor :clean
     attr_accessor :readme_path
     attr_accessor :docset_platform
+    attr_accessor :root_url
+    attr_accessor :version
+    attr_accessor :min_acl
 
     def initialize
       self.output = Pathname('docs')
       self.xcodebuild_arguments = []
       self.author_name = ''
       self.module_name = ''
-      self.github_url = nil
-      self.github_file_prefix = nil
-      self.author_url = ''
-      self.dash_url = nil
-      self.sourcekitten_sourcefile = nil
+      self.author_url = URI('')
       self.clean = false
       self.docset_platform = 'jazzy'
+      self.version = '1.0'
+      self.min_acl = SourceDeclaration::AccessControlLevel.internal
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -62,7 +67,7 @@ module Jazzy
 
         opt.on('-u', '--author_url URL',
                'Author URL of this project (i.e. http://realm.io)') do |u|
-          config.author_url = u
+          config.author_url = URI(u)
         end
 
         opt.on('-m', '--module MODULE_NAME',
@@ -71,14 +76,15 @@ module Jazzy
         end
 
         opt.on('-d', '--dash_url URL',
-               'URL to install docs in Dash (i.e. dash-feed://...') do |d|
-          config.dash_url = d
+               'Location of the dash XML feed \
+               (i.e. http://realm.io/docsets/realm.xml') do |d|
+          config.dash_url = URI(d)
         end
 
         opt.on('-g', '--github_url URL',
                'GitHub URL of this project (i.e. \
                 https://github.com/realm/realm-cocoa)') do |g|
-          config.github_url = g
+          config.github_url = URI(g)
         end
 
         opt.on('--github-file-prefix PREFIX',
@@ -92,6 +98,29 @@ module Jazzy
           config.sourcekitten_sourcefile = Pathname(s)
         end
 
+        opt.on('-r', '--root-url URL',
+               'Absolute URL root where these docs will be stored') do |r|
+          config.root_url = URI(r)
+          if !config.dash_url && config.root_url
+            config.dash_url = URI.join(r, "docsets/#{config.module_name}.xml")
+          end
+        end
+
+        opt.on('--module-version VERSION',
+               'module version. will be used when generating docset') do |mv|
+          config.version = mv
+        end
+
+        opt.on('--min-acl [private | internal | public]',
+               'minimum access control level to document \
+               (default is internal)') do |acl|
+          if acl == 'private'
+            config.min_acl = SourceDeclaration::AccessControlLevel.private
+          elsif acl == 'public'
+            config.min_acl = SourceDeclaration::AccessControlLevel.public
+          end
+        end
+
         opt.on('-v', '--version', 'Print version number') do
           puts 'jazzy version: ' + Jazzy::VERSION
           exit
@@ -136,4 +165,5 @@ module Jazzy
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/jazzy/doc_builder.rb

@@ -31,7 +31,7 @@ module Jazzy
       docs.each do |doc|
         structure << {
           section: doc.name,
-          children: doc.children.map do |child|
+          children: doc.children.sort_by(&:name).map do |child|
             { name: child.name, url: child.url }
           end,
         }
@@ -97,7 +97,10 @@ module Jazzy
       output_dir = options.output
       prepare_output_dir(output_dir, options.clean)
 
-      (docs, coverage) = SourceKitten.parse(sourcekitten_output)
+      (docs, coverage) = SourceKitten.parse(
+        sourcekitten_output,
+        options.min_acl,
+      )
 
       structure = doc_structure_for_docs(docs)
 
@@ -141,8 +144,8 @@ module Jazzy
       doc[:structure] = source_module.doc_structure
       doc[:module_name] = source_module.name
       doc[:author_name] = source_module.author_name
-      doc[:author_website] = source_module.author_url
-      doc[:github_url] = source_module.github_url
+      doc[:author_website] = source_module.author_url.to_s
+      doc[:github_url] = source_module.github_url.to_s
       doc[:dash_url] = source_module.dash_url
       doc[:path_to_root] = path_to_root
       doc.render
@@ -218,7 +221,6 @@ module Jazzy
     # @param [Array] doc_structure doc structure comprised of section names and
     #        child names and URLs. @see doc_structure_for_docs
     def self.document(source_module, doc_model, path_to_root)
-      # @todo render README here
       if doc_model.name == 'index'
         return document_index(source_module, path_to_root)
       end
@@ -233,8 +235,8 @@ module Jazzy
       doc[:tasks] = render_tasks(source_module, doc_model.children)
       doc[:module_name] = source_module.name
       doc[:author_name] = source_module.author_name
-      doc[:author_website] = source_module.author_url
-      doc[:github_url] = source_module.github_url
+      doc[:author_website] = source_module.author_url.to_s
+      doc[:github_url] = source_module.github_url.to_s
       doc[:dash_url] = source_module.dash_url
       doc[:path_to_root] = path_to_root
       doc.render

data/lib/jazzy/docset_builder.rb

@@ -13,9 +13,9 @@ module Jazzy
       attr_reader :documents_dir
 
       def initialize(output_dir, source_module)
-        @output_dir = output_dir
+        @output_dir = output_dir + 'docsets'
         @source_module = source_module
-        @docset_dir = output_dir + "#{source_module.name}.docset"
+        @docset_dir = @output_dir + "#{source_module.name}.docset"
         @documents_dir = docset_dir + 'Contents/Resources/Documents/'
       end
 
@@ -25,6 +25,7 @@ module Jazzy
         write_plist
         create_index
         create_archive
+        create_xml if config.version && config.root_url
       end
 
       private
@@ -53,7 +54,7 @@ module Jazzy
       end
 
       def copy_docs
-        files_to_copy = Dir.glob(output_dir + '**/*')
+        files_to_copy = Dir.glob(output_dir + '../**/*')
 
         FileUtils.mkdir_p documents_dir
         FileUtils.cp_r files_to_copy, documents_dir
@@ -72,6 +73,14 @@ module Jazzy
           end
         end
       end
+
+      def create_xml
+        (output_dir + "#{source_module.name}.xml").open('w') do |xml|
+          url = URI.join(config.root_url, "docsets/#{source_module.name}.tgz")
+          xml << "<entry><version>#{config.version}</version><url>#{url}" \
+                 "</url></entry>\n"
+        end
+      end
     end
   end
 end

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.0.16' unless defined? Jazzy::VERSION
+  VERSION = '0.0.17' unless defined? Jazzy::VERSION
 end

data/lib/jazzy/partials/task.mustache

@@ -28,7 +28,7 @@
           <div class="abstract">
             {{{abstract}}}
             {{#url}}
-            <a href="{{{url}}}" class="see-more">See more</a>
+            <a href="{{{path_to_root}}}{{{url}}}" class="see-more">See more</a>
             {{/url}}
           </div>
           {{/abstract}}

data/lib/jazzy/source_declaration/access_control_level.rb

@@ -0,0 +1,41 @@
+module Jazzy
+  class SourceDeclaration
+    class AccessControlLevel
+      include Comparable
+
+      attr_reader :level
+
+      def initialize(declaration_string)
+        if declaration_string =~ /private\ /
+          @level = :private
+        elsif declaration_string =~ /public\ /
+          @level = :public
+        else
+          @level = :internal
+        end
+      end
+
+      def self.private
+        AccessControlLevel.new('private ')
+      end
+
+      def self.internal
+        AccessControlLevel.new('internal ')
+      end
+
+      def self.public
+        AccessControlLevel.new('public ')
+      end
+
+      LEVELS = {
+        private: 0,
+        internal: 1,
+        public: 2,
+      }.freeze
+
+      def <=>(other)
+        LEVELS[level] <=> LEVELS[other.level]
+      end
+    end
+  end
+end

data/lib/jazzy/source_declaration.rb

@@ -1,3 +1,4 @@
+require 'jazzy/source_declaration/access_control_level'
 require 'jazzy/source_declaration/type'
 
 module Jazzy
@@ -16,5 +17,6 @@ module Jazzy
     attr_accessor :parameters
     attr_accessor :url
     attr_accessor :mark
+    attr_accessor :access_control_level
   end
 end

data/lib/jazzy/source_module.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 require 'jazzy/config'
 require 'jazzy/source_declaration'
 
@@ -22,7 +24,8 @@ module Jazzy
       self.github_url = options.github_url
       self.github_file_prefix = options.github_file_prefix
       self.author_url = options.author_url
-      self.dash_url = options.dash_url
+      return unless options.dash_url
+      self.dash_url = "dash-feed://#{URI.encode(options.dash_url.to_s, /\W/)}"
     end
 
     def all_declarations

data/lib/jazzy/sourcekitten.rb

@@ -10,6 +10,9 @@ require 'jazzy/highlighter'
 module Jazzy
   # This module interacts with the sourcekitten command-line executable
   module SourceKitten
+    @documented = 0
+    @undocumented = 0
+
     # Group root-level docs by type and add as children to a group doc element
     def self.group_docs(docs, type)
       group, docs = docs.partition { |doc| doc.type == type }
@@ -38,7 +41,6 @@ module Jazzy
           doc.url = parents.join('/') + '.html#/' + doc.usr
         end
       end
-      docs
     end
 
     # Run sourcekitten with given arguments and return STDOUT
@@ -56,28 +58,57 @@ module Jazzy
       declaration.children = []
     end
 
+    def self.documented_child?(doc)
+      return false unless doc['key.substructure']
+      doc['key.substructure'].each do |child|
+        return true if documented_child?(child)
+      end
+      false
+    end
+
+    def self.should_document?(doc)
+      # Always document extensions, since we can't tell what ACL they are
+      return true if doc['key.kind'] == 'source.lang.swift.decl.extension'
+
+      SourceDeclaration::AccessControlLevel.new(doc['key.annotated_decl']) >=
+        @min_acl
+    end
+
+    def self.process_undocumented_token(doc, declaration)
+      @undocumented += 1
+      return nil unless documented_child?(doc)
+      make_default_doc_info(declaration)
+    end
+
+    def self.parameters_from_xml(xml)
+      xml.xpath('Parameters/Parameter').map do |parameter_el|
+        {
+          name: XMLHelper.xpath(parameter_el, 'Name'),
+          discussion: Jazzy.markdown.render(
+              XMLHelper.xpath(parameter_el, 'Discussion') || '',
+            ),
+        }
+      end
+    end
+
     def self.make_doc_info(doc, declaration)
+      return nil unless should_document?(doc)
       xml_key = 'key.doc.full_as_xml'
-      return make_default_doc_info(declaration) unless doc[xml_key]
+      return process_undocumented_token(doc, declaration) unless doc[xml_key]
+      @documented += 1
 
       xml = Nokogiri::XML(doc[xml_key]).root
       declaration.line = XMLHelper.attribute(xml, 'line').to_i
       declaration.column = XMLHelper.attribute(xml, 'column').to_i
-      decl = XMLHelper.xpath(xml, 'Declaration')
-      declaration.declaration = Highlighter.highlight(decl, 'swift')
+      declaration.declaration = Highlighter.highlight(
+        doc['key.parsed_declaration'] || XMLHelper.xpath(xml, 'Declaration'),
+        'swift',
+      )
       declaration.abstract = XMLHelper.xpath(xml, 'Abstract')
       declaration.discussion = XMLHelper.xpath(xml, 'Discussion')
       declaration.return = XMLHelper.xpath(xml, 'ResultDiscussion')
 
-      declaration.parameters = []
-      xml.xpath('Parameters/Parameter').each do |parameter_el|
-        declaration.parameters << {
-          name: XMLHelper.xpath(parameter_el, 'Name'),
-          discussion: Jazzy.markdown.render(
-              XMLHelper.xpath(parameter_el, 'Discussion'),
-            ),
-        }
-      end
+      declaration.parameters = parameters_from_xml(xml)
     end
 
     def self.make_substructure(doc, declaration)
@@ -91,6 +122,7 @@ module Jazzy
     end
 
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.make_source_declarations(docs)
       declarations = []
       current_mark = SourceMark.new
@@ -116,35 +148,35 @@ module Jazzy
         declaration.usr  = doc['key.usr']
         declaration.name = doc['key.name']
         declaration.mark = current_mark
+        acl = SourceDeclaration::AccessControlLevel.new(
+          doc['key.annotated_decl'],
+        )
+        declaration.access_control_level = acl
 
-        make_doc_info(doc, declaration)
+        next unless make_doc_info(doc, declaration)
         make_substructure(doc, declaration)
         declarations << declaration
       end
       declarations
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 
-    def self.doc_coverage(sourcekitten_json)
-      documented = sourcekitten_json
-                    .map { |el| el['key.doc.documented'] }
-                    .inject(:+)
-      undocumented = sourcekitten_json
-                      .map { |el| el['key.doc.undocumented'] }
-                      .inject(:+)
-      return 0 if documented == 0 && undocumented == 0
-      (100 * documented) / (undocumented + documented)
+    def self.doc_coverage
+      return 0 if @documented == 0 && @undocumented == 0
+      (100 * @documented) / (@undocumented + @documented)
     end
 
     # Parse sourcekitten STDOUT output as JSON
     # @return [Hash] structured docs
-    def self.parse(sourcekitten_output)
+    def self.parse(sourcekitten_output, min_acl)
+      @min_acl = min_acl
       sourcekitten_json = JSON.parse(sourcekitten_output)
       docs = make_source_declarations(sourcekitten_json)
       SourceDeclaration::Type.all.each do |type|
         docs = group_docs(docs, type)
       end
-      [make_doc_urls(docs, []), doc_coverage(sourcekitten_json)]
+      [make_doc_urls(docs, []), doc_coverage]
     end
   end
 end

data/spec/integration_spec.rb

@@ -90,13 +90,17 @@ describe_cli 'jazzy' do
                             '-u https://nshipster.com/alamofire ' \
                             '-x -project,Alamofire.xcodeproj ' \
                             '-g https://github.com/Alamofire/Alamofire ' \
-                            '--github-file-prefix https://github.com/Alamofire/Alamofire/blob/1.1.0'
+                            '--github-file-prefix https://github.com/' \
+                            'Alamofire/Alamofire/blob/1.1.0 ' \
+                            '--module-version 1.1.0 ' \
+                            '-r http://static.realm.io/jazzy_demo/Alamofire/'
     end
     describe 'Creates docs for Swift project with a variety of contents' do
       behaves_like cli_spec 'misc_jazzy_features',
                             '-m MiscJazzyFeatures -a Realm ' \
                             '-u https://github.com/realm/jazzy ' \
-                            '-g https://github.com/realm/jazzy '
+                            '-g https://github.com/realm/jazzy ' \
+                            '--min-acl private'
     end
   end
 end

data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html

@@ -24,8 +24,9 @@
     <a title="Manager Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p>
+        <p class="header-text"><a href="../index.html">Alamofire Docs</a> (83% documented)</p>
         <p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
+        <p id="header-links"><a href="dash-feed://http%3A%2F%2Fstatic%2Erealm%2Eio%2Fjazzy_demo%2FAlamofire%2Fdocsets%2FAlamofire%2Exml"><img id="header-icon" src="../img/dash.png" height="16px" width="16px" />Install in Dash</a></p>
       </div>
     </header>
     <section id="valence">
@@ -74,25 +75,22 @@
           <a href="../Extensions.html">Extensions</a>
             <ul class="nav-chapters">
               <li class="nav-chapter">
-                <a href="../Extensions.html#/s:SS">String</a>
+                <a href="../Extensions/Manager.html">Manager</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
+                <a href="../Extensions/Manager.html">Manager</a>
               </li>
               <li class="nav-chapter">
                 <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Extensions/Request.html">Request</a>
-              </li>
-              <li class="nav-chapter">
-                <a href="../Extensions/Manager.html">Manager</a>
+                <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
               </li>
               <li class="nav-chapter">
                 <a href="../Extensions.html#/s:C9Alamofire7Request">Request</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Extensions/Manager.html">Manager</a>
+                <a href="../Extensions/Request.html">Request</a>
               </li>
               <li class="nav-chapter">
                 <a href="../Extensions/Request.html">Request</a>
@@ -112,43 +110,46 @@
               <li class="nav-chapter">
                 <a href="../Extensions/Request.html">Request</a>
               </li>
+              <li class="nav-chapter">
+                <a href="../Extensions.html#/s:SS">String</a>
+              </li>
             </ul>
           </li>
           <li class="part-name tasks">
           <a href="../Functions.html">Functions</a>
             <ul class="nav-chapters">
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
+                <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
               </li>
               <li class="nav-chapter">
                 <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
+                <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
               </li>
             </ul>
           </li>
@@ -156,10 +157,10 @@
           <a href="../Protocols.html">Protocols</a>
             <ul class="nav-chapters">
               <li class="nav-chapter">
-                <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
+                <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
               </li>
               <li class="nav-chapter">
-                <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
+                <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
               </li>
             </ul>
           </li>
@@ -202,7 +203,7 @@
             
                         <div class="Swift">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="k">var</span> <span class="nv">sharedInstance</span><span class="p">:</span> <span class="kt">Manager</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="k">var</span> <span class="nv">sharedInstance</span><span class="p">:</span> <span class="kt">Manager</span></code></pre>
 
                         </div>
                       </div>
@@ -262,7 +263,7 @@
             
                         <div class="Swift">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startRequestsImmediately</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span></code></pre>
 
                         </div>
                       </div>
@@ -286,14 +287,13 @@
                       <div class="pointy-thing"></div>
                       <div class="abstract">
                         
-                        <a href="Classes/Manager/init(configuration:).html" class="see-more">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
             
                         <div class="Swift">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">configuration</span><span class="p">:</span> <span class="kt">NSURLSessionConfiguration</span><span class="p">?</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span></code></pre>
+                          <pre class="highlight"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">configuration</span><span class="p">:</span> <span class="kt">NSURLSessionConfiguration</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
 
                         </div>
                       </div>
@@ -351,7 +351,7 @@
             
                         <div class="Swift">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="n">_</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
+                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="n">_</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="o">.</span><span class="kt">URL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
 
                         </div>
                       </div>