docurium 0.0.2 → 0.0.3

data/TODO.txt

@@ -1,10 +1,11 @@
 TODO
 
-* links to example usage from example docco'd code
-
+* cross-link rocco code
 
 * fix to group chooser
 
+* version history for types, too
+
 * only update certain tags / HEAD, force full update
 
 * doc other branches (specify in config file)

data/lib/docurium.rb

@@ -6,7 +6,7 @@ require 'docurium/layout'
 require 'pp'
 
 class Docurium
-  Version = VERSION = '0.0.2'
+  Version = VERSION = '0.0.3'
 
   attr_accessor :branch, :output_dir, :data
 
@@ -69,13 +69,33 @@ class Docurium
               end
               files.each do |file|
                 out "    # #{file}"
+
+                # highlight, roccoize and link
                 rocco = Rocco.new(file, files, {:language => 'c'})
                 rocco_layout = Rocco::Layout.new(rocco, tf)
                 rocco_layout.version = version
                 rf = rocco_layout.render
+
                 rf_path = File.basename(file).split('.')[0..-2].join('.') + '.html'
                 rel_path = "ex/#{version}/#{rf_path}"
                 rf_path = File.join(outdir, rel_path)
+
+                # look for function names in the examples and link
+                id_num = 0
+                @data[:functions].each do |f, fdata|
+                  rf.gsub!(/#{f}([^\w])/) do |fmatch|
+                    extra = $1
+                    id_num += 1
+                    name = f + '-' + id_num.to_s
+                    # save data for cross-link
+                    @data[:functions][f][:examples] ||= {}
+                    @data[:functions][f][:examples][file] ||= []
+                    @data[:functions][f][:examples][file] << rel_path + '#' + name
+                    "<a name=\"#{name}\" href=\"../../##{version}/group/#{fdata[:group]}/#{f}\">#{f}</a>#{extra}"
+                  end
+                end
+
+                # write example to docs directory
                 FileUtils.mkdir_p(File.dirname(rf_path))
                 File.open(rf_path, 'w+') do |f|
                   @data[:examples] ||= []
@@ -239,6 +259,7 @@ class Docurium
       if !rest
         group = value[:file].gsub('.h', '').gsub('/', '_')
       end
+      @data[:functions][key][:group] = group
       func[group] ||= []
       func[group] << key
       func[group].sort!

data/site/css/style.css

@@ -184,6 +184,10 @@ h1.funcTitle small {
   padding: 10px;
 }
 
+.funcEx {
+  padding: 10px;
+}
+
 .signatures a {
   background: #ddd;
   padding: 4px;

data/site/js/docurium.js

@@ -181,6 +181,23 @@ $(function() {
       flink = $('<a>').attr('target', 'github').attr('href', link).append(fdata[fname].file)
       content.append($('<div>').addClass('fileLink').append("Defined in: ").append(flink))
 
+      // Show where this is used in the examples
+      if(ex = fdata[fname].examples) {
+        also = $('<div>').addClass('funcEx')
+        also.append("Used in examples: ")
+        for( fname in ex ) {
+          lines = ex[fname]
+          line = $('<li>')
+          line.append($('<strong>').append(fname))
+          for( var i in lines ) {
+            flink = $('<a>').attr('href', lines[i]).append(' [' + (parseInt(i) + 1) + '] ')
+            line.append(flink)
+          }
+          also.append(line)
+        }
+        content.append(also)
+      }
+
       // Show other functions in this group
       also = $('<div>').addClass('also')
       flink = $('<a href="#" ref="' + ref.toString() + '" id="groupItem' + group[0] + '">' + group[0] + '</a>')
@@ -377,19 +394,7 @@ $(function() {
 
     groupHash: false,
     groupOf: function (func) {
-      if(!this.groupHash) {
-        this.groupHash = {}
-        data = this.get('data')
-        for(var i=0; i<data['groups'].length; i++) {
-          group = data['groups'][i][1]
-          groupName = data['groups'][i][0]
-          for(var j=0; j<group.length; j++) {
-            f = group[j]
-            this.groupHash[f] = groupName
-          }
-        }
-      }
-      return this.groupHash[func]
+      return this.get('data').functions[func].group
     },
 
     addHotlinks: function() {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: docurium
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Scott Chacon