美文网首页iOS Developer
ios如何自动生成项目api appledoc文档

ios如何自动生成项目api appledoc文档

作者: Eve_wang | 来源:发表于2017-08-03 17:13 被阅读99次

    第一步  安装appledoc  

       (1)下载appledoc

          git clone git://github.com/tomaz/appledoc.git

      (2)切换目录

         cd./appledoc

    (3)管理员权限安装

        sudo sh install-appledoc.sh

    Run Script 集成在项目内 这个方法就是把生成方式放在项目内啦,方便更新文档而已。缺点是得为每个项目添加,看个人情况使用吧。

     1、选中你的项目,点击 Add Target 按钮,选择Cross-platform --> Aggregate 

    2、点击Add Build Phase 按钮,添加一个Run Script。

     3、把下面的模板嗲吗复制进入,把前几行参数改成自己的。

     4、在Xcode左上角选择这个新建的Target,然后build。(将运行左边的app选为新建的target) 

    5、文档就会编译好并且自动安装进Xcode了(重启Xcode生效)。

    #appledoc Xcode script# Start constantscompany="ACME";companyID="com.ACME";companyURL="http://ACME.com";target="iphoneos";#target="macosx";outputPath="~/help";# End constants/usr/local/bin/appledoc \--project-name"${PROJECT_NAME}"\--project-company"${company}"\--company-id"${companyID}"\--docset-atom-filename"${company}.atom"\--docset-feed-url"${companyURL}/${company}/%DOCSETATOMFILENAME"\--docset-package-url"${companyURL}/${company}/%DOCSETPACKAGEFILENAME"\--docset-fallback-url"${companyURL}/${company}"\--output"${outputPath}"\--publish-docset \--docset-platform-family"${target}"\--logformat xcode \--keep-intermediate-files \--no-repeat-first-par \--no-warn-invalid-crossref \--exit-threshold2\"${PROJECT_DIR}"

    相关文章

      网友评论

        本文标题:ios如何自动生成项目api appledoc文档

        本文链接:https://www.haomeiwen.com/subject/xhzkpttx.html