2 Replies Latest reply on Oct 8, 2012 11:02 PM by Supreet R

    API documentation

    Supreet R

      Hi,

          I am generating an API documentation for the custom

          Datagrid component created, so I want to include

          an example of that component and the swf file for the

          same in API documentation.

         

          How can this be done...?

         

      Thanks

      Supreet R

        • 1. Re: API documentation
          Abhishek Chaudhary Level 1

          Hi Supreet,

           

          Its done using ASDOC

           

          You can either do it using command prompt or using Flash Builder

           

          To do it Flash Builder Way :

          Go to external tools configuration, New Launch Configuation

           

          Specify following parameters:

          Location : Location of asdoc.exe (C:\Program Files\Adobe\Adobe Flash Builder 4.6\sdks\4.6.0\bin\asdoc.exe)

           

          Working Directory : ${project_loc}/src

           

          Arguments :

          -source-path .

          -doc-sources .

          DOCS

          -strict=false

           

          (here . symbolizes current directory, DOCS specifies folder under which ASDOCS needs to be generated)

           

          There are many issues with ASDOCs, for a simple/complex projects, definitions of few basic libraries like objects, commands are not found.

          You need to explicitly include swcs or libraries

          like -external-library-path "C:/Users/achaudhary/trunk/24thJul/MBM/libs/robotlegs-framework-v1.5.2.swc"

           

           

          Regards,

          Abhishek Chaudhary

          InfoCepts.

           

           

          Untitled.png

          • 2. Re: API documentation
            Supreet R Level 1

            Hi Abhishek,

                 Thank you for the reply.

             

            I generated the API documentation using the procedure you described, but i was not able to include examples(both mxml and swf files)

            in the API documentation.

             

            http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/spark/components/DataGr id.html#includeExamplesSummary

            The above link shows both mxml and swf files included for DataGrid  - AS3 Flex API documentation provided by Adobe,

            I want to generate the API documentation in the same way.

             

            Could you please help me in solving this problem?

             

            Thanks

            Supreet R