Class: FlashSDK::AsDoc

Inherits:
CompilerBase
  • Object
show all
Defined in:
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:

Instance Attribute Summary

Attributes inherited from CompilerBase

#fcsh_port, #use_fcsh

Instance Method Summary collapse

Methods inherited from CompilerBase

#accessible, #actionscript_file_encoding, #allow_source_path_overlap, #as3, #benchmark, #context_root, #contributor, #creator, #date, #debug, #debug_password, #default_background_color, #default_css_url, #default_frame_rate, #default_script_limits, #default_size, #define_conditional, #description, #dump_config, #el, #es, #external_library_path, #externs, #file_specs, #fonts_languages_language_range, #fonts_managers, #fonts_max_cached_fonts, #fonts_max_glyphs_per_face, #frames_frame, #generate_frame_loader, #headless_server, #include_libraries, #include_path, #includes, #incremental, #keep_as3_metadata, #keep_generated_actionscript, #l, #language, #lazy_init, #library_path, #license, #link_report, #load_config, #load_externs, #locale, #localized_description, #localized_title, #namespaces_namespace, #optimize, #output, #publisher, #raw_metadata, #resource_bundle_list, #rsl, #rslp, #runtime_shared_libraries, #runtime_shared_library_path, #services, #show_actionscript_warnings, #show_binding_warnings, #show_deprecation_warnings, #show_shadowed_device_font_warnings, #show_unused_type_selector_warnings, #source_path, #static_link_runtime_shared_libraries, #static_rsls, #strict, #target_player, #theme, #title, #use_network, #use_resource_bundle_metadata, #verbose_stacktraces, #verify_digests, #warn_warning_type, #warnings

Instance Method Details

Boolean specifies whether to include the date in the footer.



44
 
# File 'lib/flashsdk/asdoc.rb', line 44

add_param :date_in_footer, Boolean

#default_prefix ⇒ Object

The default prefix for shell params.



22
 
# File 'lib/flashsdk/asdoc.rb', line 22

set :default_prefix, '-'

#doc_classes ⇒ Object

List of classes to include in the documentation.



53
 
# File 'lib/flashsdk/asdoc.rb', line 53

add_param :doc_classes, Strings

#doc_namespaces ⇒ Object

List of namespaces to include in the documentation.



57
 
# File 'lib/flashsdk/asdoc.rb', line 57

add_param :doc_namespaces, Strings

#doc_sources ⇒ Object

List of source file to include in the documentation.



48
 
# File 'lib/flashsdk/asdoc.rb', line 48

add_param :doc_sources, Files

#examples_path ⇒ Object

Path to look for the example files.



61
 
# File 'lib/flashsdk/asdoc.rb', line 61

add_param :examples_path, Paths

#exclude_classes ⇒ Object

Classes to exclude from documentation.



65
 
# File 'lib/flashsdk/asdoc.rb', line 65

add_param :exclude_classes, Strings

#exclude_dependencies ⇒ Object

Boolean specifying whether to exclude dependencies.



69
 
# File 'lib/flashsdk/asdoc.rb', line 69

add_param :exclude_dependencies, Boolean

#exclude_sources ⇒ Object

List of source files to exclude form the documentation.



73
 
# File 'lib/flashsdk/asdoc.rb', line 73

add_param :exclude_sources, Files

#executable ⇒ Object

The default executable target.



40
 
# File 'lib/flashsdk/asdoc.rb', line 40

set :executable, :asdoc

#execute ⇒ Object

TODO: Possibly remove the following from the CompilerBase

include_resource_bundles



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

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

#footer ⇒ Object

Footer string to be displayed in the documentation.



77
 
# File 'lib/flashsdk/asdoc.rb', line 77

add_param :footer, String

#include_lookup_only ⇒ Object

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



84
 
# File 'lib/flashsdk/asdoc.rb', line 84

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

#left_frameset_width ⇒ Object

Width of the left frame.



88
 
# File 'lib/flashsdk/asdoc.rb', line 88

add_param :left_frameset_width, Number

#lenient ⇒ Object

Report well-formed HTML errors as warnings.



92
 
# File 'lib/flashsdk/asdoc.rb', line 92

add_param :lenient, Boolean

#main_title ⇒ Object

Title to be displayed in the title bar.



96
 
# File 'lib/flashsdk/asdoc.rb', line 96

add_param :main_title, String

#package ⇒ Object

Specifies a description for a package name.



104
 
# File 'lib/flashsdk/asdoc.rb', line 104

add_param :package, Strings, { :delimiter => ' ' }

#package_description_file ⇒ Object

File containing description for packages.



100
 
# File 'lib/flashsdk/asdoc.rb', line 100

add_param :package_description_file, Files

#pkg_name ⇒ Object

The the Ruby file that will load the expected Sprout::Specification.

Default value is ‘flex4’



30
 
# File 'lib/flashsdk/asdoc.rb', line 30

set :pkg_name, 'flex4'

#pkg_version ⇒ Object

The default pkg version



35
 
# File 'lib/flashsdk/asdoc.rb', line 35

set :pkg_version, ">= #{FlashSDK::VERSION}"

#templates_path ⇒ Object

Path for custom templates.



108
 
# File 'lib/flashsdk/asdoc.rb', line 108

add_param :templates_path, Path

#window_title ⇒ Object

Title to be displayed in the browser window.



112
 
# File 'lib/flashsdk/asdoc.rb', line 112

add_param :window_title, String