iosxcodeappledoc

Use appledoc to generate documentation for some particular classes

I have written a simple reusable control and on looking for a way to document its functions and properties, I found this useful tool named - appledoc.

I have created a demo project to show the capabilities of my control. Now when I use appledoc to genetate document, its creating the references for demo classes also. I dont want this. I'm expecting appledoc to generate documentation for my reusable class only. How could I do that?

My runscript is like this:

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;

Tried adding my AppDelegate and ViewController class in --ignore tag, but it doesn't seems working. Is there anything I'm missing here?

Solution

  • Try by repeating --ignore flags,

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

    Hope that helps!