Commit a8b5388a authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Rename DocType to BaseType.

This way it's clear that it's not really related to the items in doc/
directory.
parent fc468f61
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
module JsDuck

  # Detects the type of documentation object: class, method, cfg, etc
  class DocType
  class BaseType
    # Given parsed documentation and code, returns the tagname for
    # documentation item.
    #
+2 −2
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ require 'jsduck/doc/parser'
require 'jsduck/doc/ast'
require 'jsduck/doc/map'
require 'jsduck/merger'
require 'jsduck/doc_type'
require 'jsduck/base_type'
require 'jsduck/class_doc_expander'

module JsDuck
@@ -51,7 +51,7 @@ module JsDuck
      def expand(docset)
        docset[:comment] = @doc_parser.parse(docset[:comment], @doc_ast.filename, docset[:linenr])
        docset[:doc_map] = Doc::Map.build(docset[:comment])
        docset[:tagname] = DocType.detect(docset[:doc_map], docset[:code])
        docset[:tagname] = BaseType.detect(docset[:doc_map], docset[:code])

        if docset[:tagname] == :class
          # expand class into several docsets, and rebuild doc-maps for all of them.
+3 −3
Original line number Diff line number Diff line
require "jsduck/doc_type"
require "jsduck/base_type"
require "jsduck/doc/map"
require "jsduck/js/ast"
require "jsduck/js/parser"
require "jsduck/css/parser"
require "jsduck/doc/parser"

describe JsDuck::DocType do
describe JsDuck::BaseType do
  def detect(string, type = :js)
    if type == :css
      node = JsDuck::Css::Parser.new(string).parse[0]
@@ -17,7 +17,7 @@ describe JsDuck::DocType do
    doc_parser = JsDuck::Doc::Parser.new
    node[:comment] = doc_parser.parse(node[:comment])
    node[:doc_map] = JsDuck::Doc::Map.build(node[:comment])
    return JsDuck::DocType.detect(node[:doc_map], node[:code])
    return JsDuck::BaseType.detect(node[:doc_map], node[:code])
  end

  describe "detects as class" do