Merge pull request #50 from tiennou/feature/link-types

Link more types in the documentation

Author: carlosmn

lib/docurium.rb

@@ -474,23 +474,34 @@ def group_functions!(data)
   end
 
   def find_type_usage!(data)
-    # go through all the functions and callbacks and see where other types are used and returned
+    # go through all functions, callbacks, and structs
+    # see which other types are used and returned
     # store them in the types data
     h = {}
     h.merge!(data[:functions])
     h.merge!(data[:callbacks])
-    h.each do |func, fdata|
+
+    structs = data[:types].find_all {|t, tdata| (tdata[:type] == :struct and tdata[:fields] and not tdata[:fields].empty?) }
+    structs = Hash[structs.map {|t, tdata| [t, tdata] }]
+    h.merge!(structs)
+
+    h.each do |use, use_data|
       data[:types].each_with_index do |tdata, i|
-        type = tdata[0]
-        data[:types][i][1][:used] ||= {:returns => [], :needs => []}
-        if fdata[:return][:type].index(/#{type}[ ;\)\*]?/)
-          data[:types][i][1][:used][:returns] << func
+        type, typeData = tdata
+
+        data[:types][i][1][:used] ||= {:returns => [], :needs => [], :fields => []}
+        if use_data[:return] && use_data[:return][:type].index(/#{type}[ ;\)\*]?/)
+          data[:types][i][1][:used][:returns] << use
           data[:types][i][1][:used][:returns].sort!
         end
-        if fdata[:argline].index(/#{type}[ ;\)\*]?/)
-          data[:types][i][1][:used][:needs] << func
+        if use_data[:argline] && use_data[:argline].index(/#{type}[ ;\)\*]?/)
+          data[:types][i][1][:used][:needs] << use
           data[:types][i][1][:used][:needs].sort!
         end
+        if use_data[:fields] and use_data[:fields].find {|f| f[:type] == type }
+          data[:types][i][1][:used][:fields] << use
+          data[:types][i][1][:used][:fields].sort!
+        end
       end
     end
   end

site/index.html

@@ -212,6 +212,15 @@ <h3>Argument in</h3>
       <a href="<%= fun.url %>"><%= fun.name %></a>.
       <% } %> <!-- if we have 'needs' -->
 
+      <% if (fields.length > 0) { %>
+      <h3>Field in</h3>
+      <% _.each(_.initial(fields), function(fun) { %>
+        <a href="<%= fun.url %>"><%= fun.name %></a>,
+      <% }) %><!-- loop over each 'field' -->
+      <% var fun = _.last(fields) %>
+      <a href="<%= fun.url %>"><%= fun.name %></a>
+      <% } %><!-- if we have 'fields' -->
+
       <div class="fileLink">
         Defined in:
         <a href="<%= fileLink.url %>"><%= fileLink.name %></a>

site/js/docurium.js

@@ -352,22 +352,28 @@ $(function() {
       var tname = tdata[0]
       var data = tdata[1]
 
-      var toPair = function(fun) {
+      var toFuncPair = function(fun) {
         var gname = this.groupOf(fun)
         var url = '#' + functionLink(gname, fun, version)
         return {name: fun, url: url}
       }
 
-      var returns = _.map(data.used.returns, toPair, docurium)
-      var needs = _.map(data.used.needs, toPair, docurium)
+      var toTypePair = function(type) {
+        var url = '#' + typeLink(type, version)
+        return {name: type, url: url}
+      }
+
+      var returns = _.map(data.used.returns, toFuncPair, docurium)
+      var needs = _.map(data.used.needs, toFuncPair, docurium)
+      var fields = _.map(data.used.fields, toTypePair, docurium)
       var fileLink = {name: data.file, url: docurium.github_file(data.file, data.line, data.lineto)}
 
       // Hot link our field types
       data.fields = _.map(data.fields, function(field) {
         return {type: this.hotLink(field.type), name: field.name, comments: field.comments}
       }, docurium)
 
-      this.set('data', {tname: tname, data: data, returns: returns, needs: needs, fileLink: fileLink})
+      this.set('data', {tname: tname, data: data, returns: returns, needs: needs, fields: fields, fileLink: fileLink})
     }
   })
 
@@ -594,18 +600,17 @@ $(function() {
       types = this.get('data')['types']
       var version = this.get('version')
 
-      for(var i=0; i<types.length; i++) {
-        type = types[i]
-        typeName = type[0]
-        typeData = type[1]
-        re = new RegExp(typeName + '\\s', 'gi');
+      _.each(types, function(type) {
+        var typeName = type[0];
+        var typeData = type[1];
+        var re = new RegExp('\\b' + typeName + '\\b', 'gi');
         var link = $('<a>').attr('href', '#' + typeLink(typeName, version)).append(typeName)[0]
         text = text.replace(re, link.outerHTML + ' ')
-      }
+      });
 
       var callbacks = this.get('data')['callbacks']
       _.each(callbacks, function(cb, typeName) {
-        re = new RegExp(typeName + '$', 'gi');
+        var re = new RegExp(typeName + '$', 'gi');
         var link = $('<a>').attr('href', '#' + functionLink('callback', typeName, version)).append(typeName)[0]
         text = text.replace(re, link.outerHTML + ' ')
       });

test/docurium_test.rb

@@ -59,7 +59,7 @@ def test_can_extract_structs_and_enums
   end
 
   def test_can_find_type_usage
-    oid = @data[:types].assoc('git_oid')
+    oid = @data[:types].find {|a| a[0] == 'git_oid' }
     oid_returns = [
       "git_commit_id",
       "git_commit_parent_oid",