4 Replies Latest reply on Aug 10, 2010 7:47 AM by Jaylach

    Building the Framework ASDocs?

    Jaylach Level 1

      Hi All,

       

      I am currently trying to build the entire ASDocs for the Flex 4 and ActionScript frameworks and I am running into some issues. I am using part of the build.xml file found inside the /asdoc/ folder inside the sdk folder. I have stripped out only the relevant asdoc information from this file.

       

      After a little bit of work I was able to get asdoc to actually start it's process without failling. The issue I'm running into now is ASDoc keeps failing when it tries to compile the code because of a gazillion CONFIG::debug statments (the error "Access of undefined property debug" is thrown). ASDoc fails with "Encountered too many errors!"

       

      Any idea how I can compile the ASDocs for the entire framework myself?

       

      Thanks!

        • 1. Re: Building the Framework ASDocs?
          JeffryHouser Level 4

          I'm a bit confused.  Are you trying to build the ASDoc tool from the source code?

           

          Or are you trying to use the ASDoc tool to generate ASDocs for the Flex Framework?

           

          If you're doing the former I can't help.  But, if you're doing the latter:

           

          "CONFIG::debug" lines look like they relate to conditional compilation options of the Flex Compiler.  I'd research those.  And perhaps you can share the actual command line arguments you're sending to the tool.

          • 2. Re: Building the Framework ASDocs?
            Jaylach Level 1

            Hi Jeffry,

             

            I am trying to run the ASDoc tool to generate the documentation for the Flex Framework. What I'm trying to get at is the intermediate XML files that get created before they are transformed into the actual HTML output. The only way I know how to do this is to run the ASDoc tool with the -keep-xml=true and -skip-xsl=true options.

             

            The issue arrives when I get to generate the documentation I get the CONFIG::debug errors.. hundreds of 'em. I'm not actually running the mxml compiler, just the ASDoc tool. Below is the command line I'm using -

             

            asdoc -load-config+=C:\test-asdoc\asdocConfig.xml -output C:\test-asdoc\output -keep-xml=true -skip-xsl=true -strict=false

             

            I should note that the asdocConfig.xml file is one I created by stripping out the relevant ASDoc tags from {sdk_path}\asdoc\build.xml.

             

            Many thanks in advance!

            • 3. Re: Building the Framework ASDocs?
              JeffryHouser Level 4

              Show us your config file.

               

              But, most likely you stripped something out that related to conditional compilation; which is why those lines are causing errors.

               

              http://livedocs.adobe.com/flex/3/html/help.html?content=compilers_21.html

              • 4. Re: Building the Framework ASDocs?
                Jaylach Level 1

                Thank you very much Jeffry! I totally missed the <define .... /> tags in the build.xml file.. whoops!

                I've included the complete asdocConfig.xml file and also the final command line I used.

                 

                Please note that this does not actually generate the real documentation, but instead generates only the intermediate XML files that are then used to create the final HTML output. If you remove the -keep-xml and -skip-xsl options, the actual HTML will be created and the intermediate XML files will be deleted (the defalut). Also note that the paths are hard coded for my setup. Paths on another computer may be different.

                 

                ~~~~~~~~~~

                asdocConfig.xml --

                 

                <?xml version="1.0"?>
                <flex-config xmlns="http://www.adobe.com/2006/flex-config">
                    <compiler>       
                  <source-path>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/airframework/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/airspark/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/flex/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/spark/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/framework/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/sparkskins/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/osmf/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/rpc/src</path-element>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/textLayout/src</path-element>
                  </source-path>  

                  <namespaces>
                   <namespace>
                    <uri>library://ns.adobe.com/flashx/textLayout</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/textLayout/manifest.xml</manifest>
                   </namespace>
                  
                   <namespace>
                    <uri>http://www.adobe.com/2006/airmxml</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/airframework/manifest.xml</manifest>
                   </namespace>
                  
                   <namespace>
                    <uri>http://www.adobe.com/2006/airspark</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/airspark/manifest.xml</manifest>
                   </namespace>
                  
                   <namespace>
                    <uri>http://www.adobe.com/2006/mxml</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/mxml-manifest.xml</manifest>
                   </namespace>
                  
                   <namespace>
                    <uri>http://www.adobe.com/2006/rpcmxml</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/rpc/manifest.xml</manifest>
                   </namespace>
                  
                   <namespace>
                    <uri>library://ns.adobe.com/flex/spark</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/projects/spark/manifest.xml</manifest>
                   </namespace>
                  
                   <namespace>
                    <uri>library://ns.adobe.com/flex/mx</uri>
                    <manifest>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/mxml-manifest.xml</manifest>
                   </namespace>
                  </namespaces>
                 
                  <library-path/>
                  <external-library-path>
                   <path-element>C:/Program Files (x86)/Adobe/Adobe Flash Builder 4/sdks/4.1.0/frameworks/libs/air/airglobal.swc</path-element>
                  </external-library-path>
                    </compiler>

                <doc-classes>
                  <class>AIRFrameworkClasses</class>
                  <class>AIRSparkClasses</class>
                  <class>FlexClasses</class>
                  <class>SparkClasses</class>
                  <class>FrameworkClasses</class>
                  <class>OSMFClasses</class>
                  <class>SparkSkinsClasses</class>
                  <class>RPCClasses</class>
                  <class>flashx.textLayout.CoreClasses</class>
                  <class>flashx.textLayout.EditClasses</class>
                  <class>flashx.textLayout.ConversionClasses</class>
                </doc-classes>
                       
                <doc-namespaces>
                  <uri>http://www.adobe.com/2006/airmxml</uri>
                  <uri>http://www.adobe.com/2006/airspark</uri>
                  <uri>library://ns.adobe.com/flex/spark</uri>
                  <uri>http://www.adobe.com/2006/mxml</uri>
                  <uri>http://www.adobe.com/2006/rpcmxml</uri>
                  <uri>library://ns.adobe.com/flashx/textLayout</uri>
                </doc-namespaces>
                </flex-config>

                 

                ~~~~~~~~~~

                command line --

                 

                asdoc -load-config+=C:\test-asdoc\asdocConfig.xml -output C:\test-asdoc\output -keep-xml=true -skip-xsl=true -lenient=true -strict=false -warnings=false -define+=CONFIG::debug,false -define+=CONFIG::release,true -define+=CONFIG::LOGGING,false -define+=CONFIG::FLASH_10_1,false