Question

我编写了一个简单的可重用控件，在寻找记录其功能和属性的方法时，我发现了这个名为appledoc的有用工具。

我创建了一个演示项目来显示我的控件的功能。现在，当我使用appledoc进行genetate文档时，它也会为demo类创建引用。我不想要这个。我期待appledoc只为我的可重用类生成文档。我怎么能这样做？

我的脚本是这样的：

APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
$APPLEDOC_PATH \
--project-name "MyControl" \
--project-company "Company Name" \
--company-id "" \
--output ${PRODUCT_NAME}Docs \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--ignore "*.m,AppDelegate.h,ViewController.h" \
--exit-threshold 2 \
${PROJECT_DIR}/${PRODUCT_NAME}
fi;

尝试在--ignore标记中添加我的AppDelegate和ViewController类，但它似乎不起作用。这里有什么我想念的吗？

Answer 1

尝试重复--ignore标志，

--ignore .m \
--ignore AppDelegate.h \
--ignore ViewController.h \

希望有所帮助！

Answer 2

在我的情况下，我通常只为我的模型创建一个文档，忽略我的PODS和所有视图控制器。

看看我如何设置它：

APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
    $APPLEDOC_PATH \
    --project-name "My APP" \
    --project-company "My Company Name" \
    --company-id "" \
    --output "PATH DIR" \
    --keep-undocumented-objects \
    --keep-undocumented-members \
    --keep-intermediate-files \
    --no-repeat-first-par \
    --no-warn-invalid-crossref \
    --ignore ".m" \
    --ignore "Pods" \
    --ignore "*Controller.h" \
    --ignore "*Cell.h" \
    --explicit-crossref \
    --keep-undocumented-objects \
    --keep-undocumented-members \
    --use-single-star \
    --no-repeat-first-par \
    --no-warn-missing-arg \
    --no-warn-undocumented-object \
    --no-warn-undocumented-member \
    --no-warn-empty-description \
    --exit-threshold 2 \
    ${PROJECT_DIR}/${PRODUCT_NAME}
fi;

我忽略了所有这些文件：

    --ignore ".m" \             #all my .m files
    --ignore "Pods" \           # All my PODS
    --ignore "*Controller.h"  \ # any controlers (a.k.a ViewController, TablewViewController, CollectionViewController )
    --ignore "*Cell.h" \        # Any cell (a.k.a UITableViewCell, UICollectionViewCell)

使用appledoc为某些特定类生成文档

2 个答案: