jazzy

1. 라이브러리 설치

[sudo] gem install jazzy

바로 설치가 안되고 에러가 발생한다.

 

M1 Mac에서 FFI 라이브러리가 호환이 안 되는 문제라는데 아래의 커멘드로 재설치해서 해결했다.

sudo gem install ffi -- --enable-libffi-alloc

ERROR1 M1 Mac ffi error

 

 

 

2. 다시 프로젝트 폴더로 이동 해서 jazzy 실행하면

다시 프로젝트를 빌드할 때 필요한 아규먼트가 없다는 에러가 발생한다.

Error2 jazzy arguments error

cli 형태로 xcode를 빌드하는 방법과 빌드에 대한 것에 대해 서치 해보고, 커맨드 라인으로 빌드를 해본다.

cocoapod을 사용하고 있어서 workspace를 사용하고 이를 빌드 아규먼트로 적용해 주면 되고, scheme도 맞는 형태로 작성한다. 자체 빌드 시에는 iOS Simulator를 destination으로 설정해서 빌드해본다.

 

xcodebuild build \ 

 -workspace ActiveLabelTest.xcworkspace \                           

 -scheme ActiveLabelTest \

 -destination "platform=iOS Simulator, name=iPhone 12, OS=15.4"

 

자 이제 위의 커맨드로 빌드가 되었으니까, jazzy도 같은 아규먼트를 주어지면 된다.

 

-x 가 xcode 빌드 옵션을 주는 옵션이고 옵션은 , 로 구분해서 작성한다.

jazzy -x -workspace,ActiveLabelTest.xcworkspace,-scheme,ActiveLabelTest

 

 

3. jam out ♪♫ to your fresh new docs in `docs`라고 나오면 성공이다.

sucess

프로젝트 폴더 안에 docs 폴더가 생기고 index.html을 선택하면 아래와 같은 화면이 표시되고, 정의된 API가 문서화되었다. 세부 화면은 캡처와 같다.

docs index.html

함수에 대해 자동으로 문서화를 해주는 것은 맞지만, 1) 함수의 설명 2) 파라미터 3) 리턴 값은 주석으로 달아줘야 반영된다.

xcode 에서 아래의 단축키를 누르면 주석이 추가되고, 그곳에 내용을 작성하면 된다.

command + option + '/' 

command + option + '/'

 

 

https://github.com/realm/jazzy

GitHub - realm/jazzy: Soulful docs for Swift & Objective-C