add api document
easylogic opened this issue · comments
API 문서화를 위해서 디렉토리 하나 추가합니다.
jsduck 이란 툴을 사용해서 api 문서를 만들게 됩니다.
jsduck 에 만들어진 문서가 자동으로 push 되게 되어 있습니다.
commit 메세지는 summernote-bot 이라고 들어옵니다.
참고하세요. ~
빌드서버는 제 개인 개발서버로 하고 있고 30분마다 한번씩 실행될 예정입니다.
코드에 주석을 달면 자동으로 문서를 만들어줍니다.
ps. 주석만 잘 될면 될 것 같네요. ㅠ
jsduck 은 https://github.com/senchalabs/jsduck/wiki 를 참고하세요.
develop 에 있는 소스를 기준으로 문서화 합니다.
링크는 이쪽으로 가시면 됩니다. http://summernote.org/jsduck/
develop 패키지가 업데이트 되었을때만 문서화를 하도록 구조를 바꿨습니다.
자세한 소스는 summernote-doc 을 참고하세요.
아직 문서화하는게 익숙하지 않아서
jsduck 으로 나온 산출물을 가지고 제가 먼저 검토한다음에 올리고 있습니다.
자동 푸쉬는 뺀 상태입니다.
참고하세요.