美文网首页
iOS生成文档

iOS生成文档

作者: WeeverLu | 来源:发表于2019-06-22 15:18 被阅读0次

    Doxygen

    官网:http://www.doxygen.org/index.html
    下载:http://www.doxygen.nl/download.html
    可以GIT和Sources and Binaries下载

    使用参考:Doxygen的使用,配置及实例

    AppleDoc

    参考:iOS 自动生成文档(Xcode)

    安装

    git clone git://github.com/tomaz/appledoc.git
     
    cd ./appledoc
     
    sudo sh install-appledoc.sh
    

    完成后可以用appledoc --version验证下。

    appledoc --version

    使用

    首先cd到你的项目文件夹下。
    跑一下下面的命令,默认会编译出docset并安装进Xcode。
    appledoc --project-name 你的项目名称 --project-company 你的公司名称 ./
    然后你的项目文件夹中就会出现这样一个文件

    image

    文件

    其次将appledoc集成到我们自己的工程中


    image

    集成

    下一步将下方脚本黏贴到runScript

    image
    #appledoc Xcode script  
     
    # Start constants  
     
    company="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-threshold 2 \
     
    "${PROJECT_DIR}"
    

    最后选择这个target编译下就好了


    image

    编译

    ps:如果这一步有出错,就退出xcode再编译一次就好了。
    生成的目录包就在刚才的docset-installed.txt中


    image

    结果

    image
    image

    相关文章

      网友评论

          本文标题:iOS生成文档

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