[javascript] 자바스크립트용 Doc문서 생성.

자바스크립트로 된 라이브러리를 개발자들에게 배포하기 앞서 API 문서를 만드는 데, javadoc 처럼 매끈(?)하게 만들 수 있는 툴을 잽싸게 찾아본 결과..

기존에 jsdoc_toolkit-2.4.0 을 사용했으나, 전역으로 사용되는 클래스나 메소드만 문서로 생성이 되는 문제(?)가 있었음(옵션설정을 하면 될 수도.. 허나 시간이 없는 관계로 그냥 포기 ㅜㅜ;;)

그래서 YUIDoc(http://yui.github.io/yuidoc/)를 사용해서 문서를 생성함.
사용법은 해당 사이트에 자세히 나와 있음.(ㅡ,.ㅡ)
node.js를 사용하는데, 윈도우용으로 설치해서 메뉴얼(!) 대로 하면 됨.

그리고, 문서 생성시 로고이미지나 버전 정보등을 설정할 수 있는데,
아래 'yuidoc.json' 을 생성하려는 js파일과 같은 디렉토리에 두고 실행하면 됨.

(yuidoc.json 파일이 없어도 생성은 된다)

yuidoc.json 파일내용에 대한 설명은 http://yui.github.io/yuidoc/args/index.html#yuidocjson-fields 참고하면 된다~!

[yuidoc.json 예제]

{

  "name": "PlayIN4Javascript",

  "description": "PlayIN4Javascript",

  "version": "0.5.0",

  "logo": "http://example.com/logo_top.gif",

  "options": {

    "outdir": "./output"

  }

}

생성된 문서는 대략 요렇게 생겼다~ :)