Flex/AIR/AS3/ANT2009.10.21 13:07
이번에는 Flash Builder Beta 2 에서 ANT로 ASDoc 문서를 만드는 법에 대해 알아보겠습니다.
원래는 월요일날 올릴 생각이었는데 개인적인 사정으로 시골을 다녀오는 바람에 블로그에 소홀해 졌었네요 ㅜ_ㅜ

우선 Flash Builder에 ANT가 설치 되어 있지 않다면 아래 글을 참고하셔서 ANT를 설치 해주시기 바랍니다~.

2009/10/16 - [프로그래밍/Flex / ActionScript] - Flash Builder 4 Beta에서 ANT 사용하기

지돌스타님의 블로그를 대부분 인용 ㅡ_ㅡ; 했습니다. 죄송 ;;; ㅎㅎ

원본글 보기 - http://blog.jidolstar.com/505

ANT로 ASDoc 문서를 만들기 위해서는 xml 파일을 만들어야 합니다.

라이브러리 프로젝트 부분에 build 폴더를 만든 후 build.properties 파일과 build.xml 파일을 생성합니다.


build.properties
#-------------------------------------------------------------------------------
# Properties
#-------------------------------------------------------------------------------

flex4sdk.dir = C:/Program Files/Adobe/Adobe Flash Builder Beta 2/sdks/4.0.0
flex4sdk.bin.dir = ${flex4sdk.dir}/bin
flex4sdk.air.dir = ${flex4sdk.dir}/frameworks/libs/air

asdoc.exe = ${flex4sdk.bin.dir}/asdoc.exe

src.dir = ${basedir}/src
docs.dir = ${basedir}/docs

flex4sdk.dir - flex sdk가 설치된 경로를 적어줍니다.
flex4sdk.bin.dir - flex sdk의 bin 폴더의 경로를 적어줍니다.  (ANT의 환경 변수는 ${변수명} 으로 사용할 수 있습니다.)
flex4sdk.air.dir - air 라이브러리가 있는 경로를 적어줍니다.

asdoc.exe - asdoc 실행파일의 경로를 적어줍니다.

src.dir - 소스 파일의 경로를 적어줍니다. ( ${basedir}은 build.xml 파일에 basedir에 설정된 경로를 의미합니다. )
docs.dir - ASDoc 문서를 생성할 경로를 적어줍니다.

(태그 안의 파라메타를 제외하고 태그명은 전부 소문자로 해주세요. 소문자로 적었는데도 자꾸 대문자로 변경이 되버리네요;;)
build.xml


    
    
    
    	
    
    
    
    	
    
    
        
        
    
    	
    
    
        
            
            
            
            
            
            
        
    

    
    
        
        	
        	
        	
            
            
        	
            
        
    


<project name="asdoc" basedir="../">

build 폴더를 안에 build.properties 파일과 build.xml파일을 만들었다면 basedir을 ../로 지정합니다.

<property file="./build/build.properties" />

환경 설정 파일의 경로를 적어줍니다. ( basedir 이 "../" 이므로 ./build/build.properties 라고 적어줍니다. )

<property name="window_title" value="Comet's library API Document"/>
<property name="main_title" value="Comet's library"/>
<property name="footer" value="2009 Comet @ All right reserved."/>

window_title과 main_title, footer 속성을 따로 xml에서 지정해 주는 이유는 build.properties 파일에 설정할 경우
한글이 제대로 나오지 않는 문제가 있어 build.xml 문서에서 따로 지정하여 줍니다. 만약 영문으로만 적을 경우
build.properties 파일에
window_title = Comet's library API Document
이런식으로 적어주면 build.xml에서 따로 설정하실 필요가 없습니다.

<!-- docs 폴더 삭제 후 다시 생성 -->
    <target name="asdoc_clean">
        <delete dir="${docs.dir}" failOnError="false" includeEmptyDirs="true"/>
        <mkdir dir="${docs.dir}"/>
    </target>

docs 폴더를 삭제 후 다시 생성하는 이유는 기존에 만들어진 ASDoc 문서의 파일들이 남아있을 경우 새롭게 작성된 liberary와 내용이 다를 수 있기 때문에 폴더 전체를 삭제 후 다시 생성하게 작성합니다.

<!-- flex용 ASDoc 만들기 -->
    <target name="create_asdoc_flex" depends="asdoc_clean">
        <exec executable="${asdoc.exe}" failOnError="true">
            <arg line='-doc-sources "${src.dir}"'/>
            <arg line='-source-path "${src.dir}"'/>
            <arg line='-window-title "${window_title}"'/>
            <arg line='-main-title "${main_title}"'/>
            <arg line='-footer "${footer}"'/>
            <arg line='-output "${docs.dir}"'/>
        </exec>
    </target>

    <!-- AIR용 ASDoc 만들기 -->
    <target name="create_asdoc_air" depends="asdoc_clean">
        <exec executable="${asdoc.exe}" failOnError="true">
            <arg line='-doc-sources "${src.dir}"'/>
            <arg line='-source-path "${src.dir}"'/>
            <arg line='-window-title "${window_title}"'/>
            <arg line='-main-title "${main_title}"'/>
            <arg line='-footer "${footer}"'/>
            <arg line='-output "${docs.dir}"'/>
            <arg line='-library-path+="${flex4sdk.air.dir}"'/>
        </exec>
    </target>

Flex 와 AIR 용을 따로 만드는 이유는 AIR API는 AIR 라이브러리를 포함시켜 주어야 하기때문입니다.
AIR 와 Flex의 차이점은 <arg line='-library-path+="${flex4sdk.air.dir}"'/> 차이입니다.

이렇게 만들었다면 아래 그림과 같이 build.xml 파일을 Ant 창으로 드래그합니다.


정상적으로 완료 되었다면 Ant 창에 다음 그림과 같이 나타납니다.


위 그림과 같이 나왔다면 asdoc 옆의 화살표를 클릭하여 노드를 펼칩니다.


이제 ASDoc 문서를 만들 패키지 또는 클래스가 Flex 냐 AIR냐에 따라 create_asdoc_flex 나 create_asdoc_air를 더블클릭 하시면
Consol 창에 다음 그림과 같이 나타나면 ASDoc 문서가 build.properties에서 지정한 docs.dir 폴더에 생성됩니다.


( Console 창의 우측 상단 빨간색 네모가 회색으로 바끼면 ASDoc 문서 생성이 완료된 것입니다.)

ASDoc 문서가 생성이 되었다면 이제 docs 폴더로 가셔서 index.html 파일을 더블 클릭하시면 생성된 ASDoc 파일을 보실 수 있습니다.




완성~~

관련글
저작자 표시 비영리
신고
Posted by 코멧'★
Flex/AIR/AS3/ANT2009.10.16 02:58

Flex를  접한지 이제 한 몇개월 지나다 보니 Flex로 library를 만들고 싶은 욕심이 생겼습니다.;;

아직 초보가 뭔 library를 만드냐라는 황당함을 뒤로한채 ASDoc 만드는법을 찾아 보았습니다. 생각보다 ASDoc문서를 만드는게 편하지 않더군요. 음... 그래서 편하게 만드는법을 찾아봤더니 제가 구입한 책중 Flex3 Knowhow Bible에 ANT로 ASDoc를 만드는법이 나와 있어서 따라해봤습니다. 잘되긴 하지만 역시나 빌더와 cmd 모드를 왔다 갔다하기도 귀찮고 걸리는게 좀 많더군요;

그래서 지돌스타님 블로그에서 ANT라고 검색해봤더니 Flex Builder 3에서 ANT 사용하기 라는 글이 있더군요!

오호 이런 좋은 글이 심봤다 ㅋ

그런데 제가 사용하고 있는 툴이 Flash Builder 4 Beta 라서 Flex Builder 3 와 하는 법이 같은지 한번 따라해 보기로 했습니다.

그럼 이제부터 Flash Builder 4 Beta 버젼에서 ANT를 사용하는 법을 알아보겠습니다.
(중간 중간 지돌스타님 블로그의 글을 인용했습니다.)

1. JDT (Eclipse Java Development Tools) 설치

ANT를 사용하기 위해서는 Flex Builder와 마찬가지로 JDT를 설치해야합니다.

우선 Flash Builder 4 Beta (이하 Flash Builder라고 하겠습니다.)를 실행합니다.



① Flash Builder의 상단 메뉴에서 Help → Software Updates → Find and Install... 메뉴를 선택합니다.




② Install/Updates 윈도우가 나타나면 "Search for new features to install" 선택한 후 Next 버튼을 누릅니다.




③ "The Eclipse Project Updates" 체크 후 Finish를 클릭합니다.



 
④  [Korea, Republic Of] 되어 있는 한국 미러 사이트 중에 아무거나 하나를 선택하신 후 Next 버튼을 누릅니다.



 
⑤ The Eclipse Project Updates → Eclipse SDK Eclipse 3.4.2 → Eclipse Java Development Tools 3.4.2. ... 를 체크 한 후 Next 버튼을 누릅니다.
( Eclipse Java Development Tools 3.4.2. ... 는 스크롤을 밑으로 좀 내리시다 보면 찾으실 수 있습니다. )



 
⑥ "I accept the terms in the license agreement"를 선택하여 license에 동의 하신후 Next 버튼을 누릅니다.



 
⑦ 설치 경로를 바꾸시려면 "Change Location ..." 버튼을 누른 후 원하시는 경로를 선택하시고 기본 설치 경로에 설치 하시려면 Finish 버튼을 누릅니다.



 
⑧ 설치 중 서명을 확인하는 창이 나오면 Install All을 눌러 설치를 계속 진행합니다.



 
⑨ 설치가 완료되면 Flash Builder를 다시 시작하겠냐는 창이 나타납니다. Yes를 눌러 프로그램을 재시작 합니다.



 
⑩ Flash Builder가 재시작 되면 상단 메뉴에서 Window → Other Views... 를 선택합니다.



 
⑪ Show View 윈도우에 Ant가 추가 된게 보이신다면 Ant를 선택하신 후 OK 버튼을 누릅니다.



 
⑫ Flash Builder 우측 하단에 ANT 창이 열립니다.


이상으로 JDT는 설치 완료~~!



ANT의 사용법은 다음에 리포팅 하겠습니다~;




저작자 표시 비영리
신고
Posted by 코멧'★

티스토리 툴바