The appledoc-vvdocumenter's intro from ldbchan

appledoc-vvdocumenter's Introduction

Installation

# 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

Integrate Document Comment in Xcode

Restart Xcode and press ⇧⌘9
Install VVDocumenter-Xcode
Now you can just type /// to generate comments automatically

Generate Documentation in Xcode

There are two ways to generate docsets:

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 run

sh generateDocset.sh

Integrate into Xcode
1. Drag autoGenerateDocset.sh into your Project folder
2. Go to Project Navigator and choose one of the Targets
3. Click the + button nearby and Add Run Script Phase
4. Paste sh ${SOURCE_ROOT}/autoGenerateDocset.sh in the box
5. Build and then docset will be generated
6. Press ⇧⌘0 to check your documentation