Commit 16c31fe8 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Rubified names of DocFormatter properties.

parent f5db039d

lib/jsduck/doc_formatter.rb

+6 −6
Original line number Diff line number Diff line
@@ -6,12 +6,12 @@ module JsDuck 
  # Formats doc-comments

  class DocFormatter

    # CSS class to add to each link

    attr_accessor :cssClass

    attr_accessor :css_class



    # Template for the href URL.

    # Can contain %cls% which is replaced with actual classname.

    # Also '#' and member name is appended to link if needed

    attr_accessor :urlTemplate

    attr_accessor :url_template



    # Sets up instance to work in context of particular class, so

    # that when {@link #blah} is encountered it knows that
@@ -23,8 +23,8 @@ module JsDuck 


    def initialize

      @context = ""

      @cssClass = nil

      @urlTemplate = "%cls%"

      @css_class = nil

      @url_template = "%cls%"

      @max_length = 120

    end
@@ -60,10 +60,10 @@ module JsDuck 
    # Creates HTML link to class and/or member

    def link(cls, member, label)

      anchor = member ? "#" + member : ""

      url = @urlTemplate.sub(/%cls%/, cls) + anchor

      url = @url_template.sub(/%cls%/, cls) + anchor

      href = ' href="' + url + '"'

      rel = ' rel="' + cls + anchor + '"'

      cssCls = @cssClass ? ' class="' + @cssClass + '"' : ''

      cssCls = @css_class ? ' class="' + @css_class + '"' : ''

      "<a" + href + rel + cssCls + ">" + label + "</a>"

    end

lib/jsduck/exporter.rb

+1 −1
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ module JsDuck 
    def initialize(relations)

      @relations = relations

      @formatter = DocFormatter.new

      @formatter.cssClass = 'docClass'

      @formatter.css_class = 'docClass'

    end



    # Returns all data in Class object as hash.

lib/jsduck/long_params.rb

+2 −2
Original line number Diff line number Diff line
@@ -8,8 +8,8 @@ module JsDuck 
    def initialize(cls)

      @formatter = DocFormatter.new()

      @formatter.context = cls.full_name

      @formatter.cssClass = 'docClass'

      @formatter.urlTemplate = 'output/%cls%.html'

      @formatter.css_class = 'docClass'

      @formatter.url_template = 'output/%cls%.html'

    end



    def render(params)

lib/jsduck/page.rb

+2 −2
Original line number Diff line number Diff line
@@ -21,8 +21,8 @@ module JsDuck 
      @cache = cache

      @formatter = DocFormatter.new

      @formatter.context = cls.full_name

      @formatter.cssClass = 'docClass'

      @formatter.urlTemplate = 'output/%cls%.html'

      @formatter.css_class = 'docClass'

      @formatter.url_template = 'output/%cls%.html'

    end



    def to_html

lib/jsduck/table.rb

+2 −2
Original line number Diff line number Diff line
@@ -22,8 +22,8 @@ module JsDuck 
      @cache = cache

      @formatter = DocFormatter.new

      @formatter.context = cls.full_name

      @formatter.cssClass = 'docClass'

      @formatter.urlTemplate = 'output/%cls%.html'

      @formatter.css_class = 'docClass'

      @formatter.url_template = 'output/%cls%.html'

    end



    def to_html