Merge pull request #530 from realm/jp-render-swift-declarations-in-objc

Render Swift declarations for Objective-C declarations

CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Master
 
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Objective-C documentation now also includes Swift declarations.  
+  [JP Simard](https://github.com/jpsim)
+  [#136](https://github.com/realm/jazzy/issues/136)
+
 ##### Bug Fixes
 
 * Uses GitHub-Flavored Markdown syntax for anchors when rendering README pages.  

lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F18b</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.8.2</string>
+	<string>0.9.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleSupportedPlatforms</key>

lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F18b</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>

lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F18b</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>

lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>BuildMachineOSBuild</key>
-	<string>15E65</string>
+	<string>15F18b</string>
 	<key>CFBundleDevelopmentRegion</key>
 	<string>en</string>
 	<key>CFBundleExecutable</key>

lib/jazzy/doc_builder.rb

@@ -284,19 +284,20 @@ def self.render_item(item, source_module)
       # Combine abstract and discussion into abstract
       abstract = (item.abstract || '') + (item.discussion || '')
       item_render = {
-        name:                    item.name,
-        abstract:                render_markdown(abstract),
-        declaration:             item.declaration,
-        usr:                     item.usr,
-        dash_type:               item.type.dash_type,
-        github_token_url:        gh_token_url(item, source_module),
-        default_impl_abstract:   render_markdown(item.default_impl_abstract),
-        from_protocol_extension: item.from_protocol_extension,
-        return:                  render_markdown(item.return),
-        parameters:              (item.parameters if item.parameters.any?),
-        url:                     (item.url if item.children.any?),
-        start_line:              item.start_line,
-        end_line:                item.end_line,
+        name:                       item.name,
+        abstract:                   render_markdown(abstract),
+        declaration:                item.declaration,
+        other_language_declaration: item.other_language_declaration,
+        usr:                        item.usr,
+        dash_type:                  item.type.dash_type,
+        github_token_url:           gh_token_url(item, source_module),
+        default_impl_abstract:      render_markdown(item.default_impl_abstract),
+        from_protocol_extension:    item.from_protocol_extension,
+        return:                     render_markdown(item.return),
+        parameters:                 (item.parameters if item.parameters.any?),
+        url:                        (item.url if item.children.any?),
+        start_line:                 item.start_line,
+        end_line:                   item.end_line,
       }
       item_render.reject { |_, v| v.nil? }
     end

lib/jazzy/source_declaration.rb

@@ -54,6 +54,7 @@ def objc_category_name
     attr_accessor :usr
     attr_accessor :name
     attr_accessor :declaration
+    attr_accessor :other_language_declaration
     attr_accessor :abstract
     attr_accessor :default_impl_abstract
     attr_accessor :from_protocol_extension

lib/jazzy/sourcekitten.rb

@@ -213,6 +213,8 @@ def self.parameters(doc)
       end
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.make_doc_info(doc, declaration)
       return unless should_document?(doc)
       unless doc['key.doc.full_as_xml']
@@ -225,6 +227,11 @@ def self.make_doc_info(doc, declaration)
         doc['key.parsed_declaration'] || doc['key.doc.declaration'],
         Config.instance.objc_mode ? 'objc' : 'swift',
       )
+      if Config.instance.objc_mode && doc['key.swift_declaration']
+        declaration.other_language_declaration = Highlighter.highlight(
+          doc['key.swift_declaration'], 'swift'
+        )
+      end
       declaration.abstract = Jazzy.markdown.render(doc['key.doc.comment'] || '')
       declaration.discussion = ''
       declaration.return = make_paragraphs(doc, 'key.doc.result_discussion')
@@ -233,6 +240,8 @@ def self.make_doc_info(doc, declaration)
 
       @documented_count += 1
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.make_substructure(doc, declaration)
       if doc['key.substructure']

lib/jazzy/themes/apple/templates/task.mustache

@@ -53,6 +53,12 @@
               <p class="aside-title">{{language}}</p>
               {{{declaration}}}
             </div>
+            {{#other_language_declaration}}
+            <div class="language">
+              <p class="aside-title">Swift</p>
+              {{{other_language_declaration}}}
+            </div>
+            {{/other_language_declaration}}
           </div>
           {{/declaration}}
           {{#parameters.count}}

lib/jazzy/themes/fullwidth/templates/task.mustache

@@ -53,6 +53,12 @@
               <p class="aside-title">{{language}}</p>
               {{{declaration}}}
             </div>
+            {{#other_language_declaration}}
+            <div class="language">
+              <p class="aside-title">Swift</p>
+              {{{other_language_declaration}}}
+            </div>
+            {{/other_language_declaration}}
           </div>
           {{/declaration}}
           {{#parameters.count}}