Geek asks and answers

Use appledoc to create documentation for some specific classes.

I wrote a simple reusable control and looking for a way to document its functions and properties, I found this useful tool called appledoc.

I created a demo project to show the possibilities of my control. Now that I use appledoc to generate a document, it also creates links to demo classes. I do not want it. I expect appledoc to only create documentation for my reusable class. How can i do this?

My scenario is as follows:

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;

I tried to add a class AppDelegateand ViewControllerin --ignore tag, but it does not work. Is something missing here?

+3
source share
2 answers

--ignore,

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

, !

+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)
0

More articles:


All Articles