0 Replies Latest reply on Jan 15, 2010 7:49 PM by Abobo

    Running ASDoc against the Flex source code

    Abobo

      Primary Goal:

      To generate a list of classes and their methods for all of the ActionScript objects.

       

      To achieve this goal, ASDoc was suggested.

      If people have other suggestions I am quite open to them.

       

      I have attempted to run ASDoc against the Flex sources in many, many different ways now and they all result in errors.

       

      Has anyone been able to successfully run ASDoc against the Flex source code?

       

      Here is my last attempt and some of the errors returned:

       

      asdoc -doc-sources C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src -library-path C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\libs\ -source-path C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src -main-title "Flex API Documentation" -window-title "Flex API Documentation" -output flex-framework-asdoc

       

      Output:

      Loading configuration file C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\flex-config.xml
      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\styles\meta data\BarColorStyle.as: Error: A file found in a source-path must have an externally visible definition. If a definition in the file is meant to be externally visible, please put the definition in a package.

       

      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\styles\meta data\TextStyles.as: Error: A file found in a source-path must have an externally visible definition. If a definition in the file is meant to be externally visible, please put the definition in a package.

       

      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\styles\meta data\SkinStyles.as: Error: A file found in a source-path must have an externally visible definition. If a definition in the file is meant to be externally visible, please put the definition in a package.

       

      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\styles\meta data\GapStyles.as: Error:A file found in a source-path must have an externally visible definition. If a definition in the file is meant to be externally visible, please put the definition in a package.

       

      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\core\ITextF ieldInterface.as(20): col: 18 Error: Function does not have a body.
          function get alwaysShowSelection():Boolean;
                       ^

       

      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\core\ITextF ieldInterface.as(21): col: 18 Error: Function does not have a body.
          function set alwaysShowSelection(value:Boolean):void;
                       ^

       

      C:\Programs\Adobe\FlexBuilder3\sdks\3.3.0\frameworks\projects\framework\src\mx\core\ITextF ieldInterface.as(26): col: 18 Error: Function does not have a body.
          function get antiAliasType():String;
                       ^

       

      ...

       

      If anyone can successfully do this I would be eternally grateful for the command line used.

       

      Thanks,

      Dave