Link to callbacks from the function view

Callbacks don't get a history view or appear in the "also in this
group", as they're not quite functions.

Author: carlosmn

lib/docurium.rb

@@ -394,7 +394,6 @@ def update_globals!(data, recs)
         data[t][r[:name]] ||= {}
         wanted[:functions].each do |k|
           next unless r.has_key? k
-          conents = nil
           if k == :description || k == :comments
             contents = md.render r[k]
           else

site/index.html

@@ -138,6 +138,7 @@ <h3>signature</h3>
        <code class="params"><%= sig %></code>
      </div>
      <!-- function history -->
+     <% if (sigs) { %>
      <div class="signatures">
        <h3>versions</h3>
        <ul>
@@ -146,6 +147,7 @@ <h3>versions</h3>
 	 <% }) %>
        </ul>
      </div>
+     <% } %> <!-- if we have version history -->
      <div class="fileLink">Defined in: <a href="<%= fileLink %>"> <%= data.file %></a></div>
      <% if (data.examples) { %>
      <div class="funcEx">Used in examples:
@@ -161,6 +163,7 @@ <h3>versions</h3>
      </ul>
      </div>
      <% } %> <!-- if we have examples -->
+     <% if (alsoLinks) { %>
      <div class="also">
        Also in <a href="<%= alsoGroup %>"><%= groupName %></a> group: <br/>
        <% _.each(_.initial(alsoLinks), function(link) { %>
@@ -169,6 +172,7 @@ <h3>versions</h3>
        <% var link = _.last(alsoLinks) %>
        <a href="<%= link.url %>"><%= link.name %></a>
      </div>
+     <% } %> <!-- if we have "also" links -->
     </script>
 
     <!-- main page, list of groups and their functions -->

site/js/docurium.js

@@ -213,42 +213,54 @@ $(function() {
       var fname = this.get('fname')
       var docurium = this.get('docurium')
 
+      var isCallback = gname === 'callback'
       var group = docurium.getGroup(gname)
 
       var fdata = docurium.get('data')['functions']
-      var functions = group[1]
+
+      var ldata = fdata
+      if (isCallback) {
+	var cdata = docurium.get('data')['callbacks']
+	ldata = cdata
+      } else {
+	var functions = group[1]
+      }
 
       // Function Arguments
-      var args = _.map(fdata[fname]['args'], function(arg) {
+      var args = _.map(ldata[fname]['args'], function(arg) {
 	return {link: this.hotLink(arg.type), name: arg.name, comment: arg.comment}
       }, docurium)
 
-      var data = fdata[fname]
+      var data = ldata[fname]
       // function return value
       var ret = data['return']
       var returns = {link: docurium.hotLink(ret.type), comment: ret.comment}
       // function signature
       var sig = docurium.hotLink(ret.type) + ' ' + fname + '(' + data['argline'] + ');'
       // version history
-      var sigHist = docurium.get('signatures')[fname]
-      var version = docurium.get('version')
-      var sigs = _.map(sigHist.exists, function(ver) {
-	var klass = []
-	if (sigHist.changes[ver])
-	  klass.push('changed')
-	if (ver == version)
-	  klass.push('current')
-
-	return {url: '#' + functionLink(gname, fname, ver), name: ver, klass: klass.join(' ')}
-      })
+      if (!isCallback) {
+	var sigHist = docurium.get('signatures')[fname]
+	var version = docurium.get('version')
+	var sigs = _.map(sigHist.exists, function(ver) {
+	  var klass = []
+	  if (sigHist.changes[ver])
+	    klass.push('changed')
+	  if (ver == version)
+	    klass.push('current')
+
+	  return {url: '#' + functionLink(gname, fname, ver), name: ver, klass: klass.join(' ')}
+	})
+      }
       // GitHub link
       var fileLink = docurium.github_file(data.file, data.line, data.lineto)
       // link to the group
-      var version = docurium.get('version')
-      var alsoGroup = '#' + groupLink(group[0], version)
-      var alsoLinks = _.map(functions, function(f) {
-	return {url: '#' + functionLink(gname, f, version), name: f}
-      })
+      if (!isCallback) {
+	var version = docurium.get('version')
+	var alsoGroup = '#' + groupLink(group[0], version)
+	var alsoLinks = _.map(functions, function(f) {
+	  return {url: '#' + functionLink(gname, f, version), name: f}
+	})
+      }
 
       this.set('data', {name: fname, data: data, args: args, returns: returns, sig: sig,
 			sigs: sigs, fileLink: fileLink, groupName: gname,
@@ -381,6 +393,7 @@ $(function() {
       var group = o.group
       var gname = group[0]
       var fdata = o.functions
+      var cdata = o.callbacks
       var version = o.version
 
       this.functions = _.map(group[1], function(name) {
@@ -556,14 +569,23 @@ $(function() {
     hotLink: function(text) {
       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 + ' ', 'gi');
+        re = new RegExp(typeName + '\\s', '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 link = $('<a>').attr('href', '#' + functionLink('callback', typeName, version)).append(typeName)[0]
+        text = text.replace(re, link.outerHTML + ' ')
+      });
+
       return text
     },
 
@@ -624,8 +646,9 @@ $(function() {
       this.doc.setVersion(version)
       var group = this.doc.getGroup(gname)
       var fdata = this.doc.get('data')['functions']
+      var cdata = this.doc.get('data')['callbacks']
       var version = this.doc.get('version')
-      var view = new GroupView({group: group, functions: fdata, version: version})
+      var view = new GroupView({group: group, functions: fdata, callbacks: cdata, version: version})
       this.mainView.setActive(view)
     },