zoukankan      html  css  js  c++  java
  • AppleDoc 使用介绍

    AppleDoc 使用介绍

    如果还未安装AppleDoc,请参考:AppleDoc 安装步骤

    项目集成了AppleDoc生成脚本,通过编译项目即可生成项目API文档。

    具体操作步骤如下:

    1. 切换项目scheme到RCodeDoc,选中Any iOS Device。

    2. 查看CodeDoc的Target。

    3. 修改脚本

    # AppleDoc Xcode script
    # Start constants
    company="xxxx";# 公司名
    companyID="com.xxxx.xxxx";# 公司ID
    companyURL="http://www.xxxx.com";# 公司网址
    target="iphoneos";# 编译平台 macosx、iphoneos
    outputPath="xxxx/xxx";
    ScanFilePath="xxxx/xxx";# 文档扫描路径 该路径下的所有类都会导出到html中 除了Pods目录下和所有.m文件
    Release="--no-warn-undocumented-object --no-warn-undocumented-member ";# 导出模式,如果有不符合备注规范的代码,也会忽略,直接生成文档。--no-warn-undocumented-object 表示没有注释的文件不提示警告;--no-warn-undocumented-member 表示没有注释的属性和方法不提示警告
    Debug="";# 调试模式,如果有不符合备注规范的代码,将会在报错日志中展示。
    # 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}" --publish-docset --logformat xcode --docset-platform-family "${target}" 
    --output "${outputPath}" 
    -i Pods -i *.m --no-warn-invalid-crossref --no-repeat-first-par --keep-intermediate-files --keep-undocumented-objects --keep-undocumented-members ${Release}
    ${ScanFilePath}
    
    

    默认配置了Release,会直接导出API文档。

    4. 找到指定的输出$(outputPath)目录,里面是编译生成的html和docset文件。

    5. html文件可以直接本地打开,也可以使用github托管

    6. 也可以使用Dash直接打开.docset文件,Dash支持搜索功能。

    https://kapeli.com/dash

    http://www.cnblogs.com/PaulpauL/ 版权声明:本文为博主原创文章,未经博主允许不得转载。
  • 相关阅读:
    Hadoop2.0 HA集群搭建步骤
    了解何为DML、DDL、DCL
    搭建Hadoop平台(新手入门)
    周记1
    IT小小鸟
    Python中的函数修饰符
    python_类方法和静态方法
    Python的log模块日志写两遍的问题
    python——装饰器例子一个
    初识HIVE
  • 原文地址:https://www.cnblogs.com/PaulpauL/p/15237790.html
Copyright © 2011-2022 走看看