Contents

# -*- coding: utf-8 -*-
# ===========================================================================
# Project:   Abbot - SproutCore Build Tools
# Copyright: ©2009 Apple Inc.
#            portions copyright @2006-2009 Sprout Systems, Inc.
#            and contributors
# ===========================================================================

require File.expand_path(File.join(File.dirname(__FILE__), 'manifest'))

module SC
  class Tools

    desc "sc-docs [TARGET..]", "Generates JSDoc's for specified targets."
    method_options(:entries  => :optional,
                   :clean    => true,
                   :language => :optional,
                   :template => :optional,
                   ['--include-required', '-r'] => false)
    def docs(*targets)

      SC.env.build_prefix   = options.buildroot if options.buildroot
      SC.env.clean          = options.clean
      SC.env.build_required = options['include-required']
      SC.env.language       = options.language
      SC.env.template_name  = options.template

      # Find all the targets
      targets = find_targets(*targets)
      targets.each do |target|
        project_root = target.project.project_root
        build_root = project_root / 'tmp' / 'docs' / target.target_name.to_s  

        if [:framework, :app].include?(target.target_type)
          if SC.env.clean
            SC.logger.info "Cleaning #{build_root}"
            FileUtils.rm_r(build_root) if File.directory?(build_root)
          end
          
          target.build_docs!(:build_root => build_root,
            :language => SC.env.language,
            :required => SC.env.build_required,
            :template => SC.env.template_name,
            :logger   => SC.logger)
        else
          SC.logger.info "#{target.target_name} is not of type framework or app. Skipping."
          SC.logger.info "#{target.target_name} is of type #{target.target_type}."
          
        end # if [:framework, :app]
      end # targets.each
    end # def docs
  end # class Tools
end # module SC

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
sproutit-sproutcore-1.0.20090721145285	lib/sproutcore/tools/docs.rb