Используйте appledoc для генерации документации для некоторых классов

Question

Я написал простой многократно используемый элемент управления и, ища способ документировать его функции и свойства, я нашел этот полезный инструмент с именем - appledoc.

Я создал демонстрационный проект, чтобы показать возможности моего контроля. Теперь, когда я использую appledoc для генерации документа, он также создает ссылки для демонстрационных классов. Я не хочу этого. Я ожидаю, что 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;

Попробовал добавить мой AppDelegate а также ViewController Класс в теге --ignore, но это не похоже на работу. Есть что-то, что я здесь скучаю?

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)