appledoc 使用brew命令安装使用

appledoc --project-name yushuyi12345677   
         --project-company "xiaoyu123" 
         --company-id aaaa  
         --output /Users/yushuyi/Desktop     
         /Users/yushuyi/Desktop/MultiFTPTask/MultiFTPTask/Classes

 

首先可以看 appledoc 使用  这篇文章，如果安装不成功 提示  -bash:appledoc command not found  ，可以再次本文尝试

1，首先检测是否 brew 是否安装

brew

如果出现了一堆brew的使用说明，就证明已经安装了

否则就没有安装，安装brew

curl -LsSf http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz -C/usr/local --strip 1

如果创建安装失败:看 /user/local 路径是否存在 ，打开 Finder ，前往 -> 前往文件夹  /user/local；如果不存在，前往 /user，创建local文件夹

2，安装 appledoc:

sudo brew install appledoc

如果安装不成功提示：/usr/local/bin is not writable. You should change its permissions.

进入 /usr/local/bin 文件夹修改读写权限，如下图：

 

完成后,此时卸载appledoc. 此时appledoc安装了一半,没有完全安装成功.

brew uninstall appledoc

3，检测 appledoc 是否安装成功

appledoc --version

appledoc --help

上面两个命令都是可以的，只要不提示失败，就好了

4，生成API文档

appledoc --project-name yushuyi12345677   
         --project-company "xiaoyu123" 
         --company-id aaaa  
         --output /Users/yushuyi/Desktop     
         /Users/yushuyi/Desktop/MultiFTPTask/MultiFTPTask/Classes

生成的API文档，一般都在这个目录里 : ~/Library/Developer/Shared/Documentation/DocSets

或者重启Xcode , 进入Window ->Documentation and API Reference

 

转载于:https://www.cnblogs.com/shidaying/p/5051956.html