Class: FlashSDK::AsDoc

Inherits:
CompilerBase show all
Defined in:
flashsdk/lib/flashsdk/asdoc.rb

Overview

The AsDoc executable is a wrapper around the Flex SDK binary of the same name.

Following is a simple example of the asdoc Rake task:

desc "Generate documentation at <%= doc %>/"
asdoc 'doc' do |t|
  t.doc_sources << 'src'

  # Exclude test main file
  t.exclude_sources << 'src/SomeProjectRunner.as'
end

See Also:

Constant Summary

Constants included from Sprout::Executable

DEFAULT_FILE_EXPRESSION, DEFAULT_PREFIX, DEFAULT_SHORT_PREFIX

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from CompilerBase

#execute_delegate, #execute_with_fcsh, #library_added, #prepare, #update_fcsh

Methods inherited from Sprout::Executable::Base

add_param, add_param_alias, #binary_path, #binary_path=, #create_outer_task, #default_file_expression, #execute_delegate, #from_hash, #initialize, #library_added, #parse!, #parse_extra_options!, #parse_rake_task_arg, #prepare, set, static_default_value_collection, static_parameter_collection, #stderr, #stderr=, #stdout, #stdout=, #system_execute, #to_hash, #to_help, #to_rake, #to_shell, #update_rake_task_name_from_args

Methods included from Sprout::Concern

#append_features, extended, #included

Constructor Details

This class inherits a constructor from Sprout::Executable::Base

Instance Attribute Details

Boolean specifies whether to include the date in the footer.

Returns:

  • (Boolean)

    An instance of Boolean



# File ''

add_param :date_in_footer, Boolean

- (Array<String>) doc_classes

List of classes to include in the documentation.

Returns:

  • (Array<String>)

    An instance of Array<String>



# File ''

add_param :doc_classes, Strings

- (Array<String>) doc_namespaces

List of namespaces to include in the documentation.

Returns:

  • (Array<String>)

    An instance of Array<String>



# File ''

add_param :doc_namespaces, Strings

- (Array<String> [Files]) doc_sources

List of source file to include in the documentation.

Returns:

  • (Array<String> [Files])

    An instance of Array<String> [Files]



# File ''

add_param :doc_sources, Files

- (Array<String> [Paths]) examples_path

Path to look for the example files.

Returns:

  • (Array<String> [Paths])

    An instance of Array<String> [Paths]



# File ''

add_param :examples_path, Paths

- (Array<String>) exclude_classes

Classes to exclude from documentation.

Returns:

  • (Array<String>)

    An instance of Array<String>



# File ''

add_param :exclude_classes, Strings

- (Boolean) exclude_dependencies

Boolean specifying whether to exclude dependencies.

Returns:

  • (Boolean)

    An instance of Boolean



# File ''

add_param :exclude_dependencies, Boolean

- (Array<String> [Files]) exclude_sources

List of source files to exclude form the documentation.

Returns:

  • (Array<String> [Files])

    An instance of Array<String> [Files]



# File ''

add_param :exclude_sources, Files

Footer string to be displayed in the documentation.

Returns:

  • (String)

    An instance of String



# File ''

add_param :footer, String

- (Boolean) include_all_for_asdoc

An instance of Boolean

Returns:

  • (Boolean)

    An instance of Boolean



# File ''

add_param :include_all_for_asdoc, Boolean

- (Boolean) include_lookup_only

If true, manifest entries with lookupOnly=true are included in SWC catalog. Default is false. (advanced)

Returns:

  • (Boolean)

    An instance of Boolean



# File ''

add_param :include_lookup_only, Boolean, { :default => false }

- (Number) left_frameset_width

Width of the left frame.

Returns:

  • (Number)

    An instance of Number



# File ''

add_param :left_frameset_width, Number

- (Boolean) lenient

Report well-formed HTML errors as warnings.

Returns:

  • (Boolean)

    An instance of Boolean



# File ''

add_param :lenient, Boolean

- (String) main_title

Title to be displayed in the title bar.

Returns:

  • (String)

    An instance of String



# File ''

add_param :main_title, String

- (Path) package

Specifies a description for a package name.

Returns:

  • (Path)

    An instance of Path



# File ''

add_param :package, Path

- (Array<String> [Files]) package_description_file

File containing description for packages.

Returns:

  • (Array<String> [Files])

    An instance of Array<String> [Files]



# File ''

add_param :package_description_file, Files

- (Path) templates_path

Path for custom templates.

Returns:

  • (Path)

    An instance of Path



# File ''

add_param :templates_path, Path

- (String) window_title

Title to be displayed in the browser window.

Returns:

  • (String)

    An instance of String



# File ''

add_param :window_title, String

Instance Method Details

- (Object) execute

TODO: Possibly remove the following from the CompilerBase

include_resource_bundles



118
119
120
121
122
123
124
125
126
# File 'flashsdk/lib/flashsdk/asdoc.rb', line 118

def execute
  # Never use fcsh for asdoc
  # (overused inheritance smell)
  self.use_fcsh = false
  start = Time.now
  super
  duration = (Time.now - start).seconds
  Sprout.stdout.puts "[ASDOC] Creation complete in #{duration} seconds."
end