Created
October 14, 2013 07:06
-
-
Save sumardi/6971875 to your computer and use it in GitHub Desktop.
AppleDoc Run Script.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/usr/local/bin/appledoc \ | |
--project-name "${PROJECT_NAME}" \ | |
--project-company "Software Machine Development" \ | |
--company-id "com.sumardi" \ | |
--output "~/Projects/Help/${PROJECT_NAME}" \ | |
--install-docset \ | |
--logformat xcode \ | |
--keep-undocumented-objects \ | |
--keep-undocumented-members \ | |
--keep-intermediate-files \ | |
--no-repeat-first-par \ | |
--no-warn-invalid-crossref \ | |
--merge-categories \ | |
--exit-threshold 2 \ | |
--docset-platform-family iphoneos \ | |
--ignore "*.m" \ | |
--include "${PROJECT_DIR}/${PROJECT_NAME}/Documentation/Images" \ | |
--ignore "LoadableCategory.h" \ | |
--index-desc "${PROJECT_DIR}/readme.markdown" \ | |
"${PROJECT_DIR}/${PROJECT_NAME}" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Install AppleDoc: | |
$ git clone git://github.com/tomaz/appledoc.git | |
$ sudo sh install-appledoc.sh | |
or | |
$ brew install appledoc | |
Usage: | |
- Add a build target | |
- Customize the build phase to call appledoc | |
- Add a readme file that is used as an introduction page |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment