# install appledoc with template
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh -t default
# install Alcatraz (only support Xcode 7+) for installing VVDocumenter-Xcode
curl -fsSL https://raw.githubusercontent.com/supermarin/Alcatraz/deploy/Scripts/install.sh | sh
- Restart Xcode and press
⇧⌘9
- Install VVDocumenter-Xcode
- Now you can just type
///
to generate comments automatically
-
Run appledoc command in Project
appledoc --project-name project --project-company company --company-id com.company --output ~/help --logformat xcode --explicit-crossref --ignore Pods --ignore .m --keep-undocumented-objects --keep-undocumented-members --no-repeat-first-par --no-warn-invalid-crossref --no-warn-undocumented-object --no-warn-undocumented-member --no-warn-empty-description --no-warn-missing-arg --exit-threshold 2 .
or drag
generateDocset.sh
into your Project and runsh generateDocset.sh
-
Integrate into Xcode
- Drag
autoGenerateDocset.sh
into your Project folder - Go to Project Navigator and choose one of the Targets
- Click the + button nearby and Add Run Script Phase
- Paste
sh ${SOURCE_ROOT}/autoGenerateDocset.sh
in the box - Build and then docset will be generated
- Press
⇧⌘0
to check your documentation
- Drag
- Documentation by Mattt Thompson (include Guidelines for Writing Objective-C Documentation)
- onevcat/VVDocumenter-Xcode
- tomaz/appledoc
- Auto-generating Docsets for your own iOS project