-
Notifications
You must be signed in to change notification settings - Fork 644
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
1. Xcode will crash on ALT-DoubleClick every time when trying to look up selected text in Xcode Organiser 2. ALT-Click shows QuickHelp bubble OK, but if the method is not from one of the standard framework classes, the 'Reference' link at the bottom of the pop-up is not shown. Thus you can't jump to Organiser help on your own classes and methods from the Quick Help bubble. 3. Added sample Xcode integration script to generate dockets automatically as target Fix Notes: 1. modify template file "tokens-template.xml" to add node reference for methods 2. modify "GBDocSetOutputGenerator.m" to add this node reference to the generated xml file
- Loading branch information
Showing
4 changed files
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
Sample script to Enamble Xcode integration | ||
========================================== | ||
|
||
appledoc can be integrated with Xcode in many ways. Below is one of those to get you up and running quickly on Xcode 4.6 | ||
|
||
1. Select top of your project in Project Navigator | ||
2. Click Add Target | ||
3. Depending on your project type (IOS or OS X) choose Aggregate Template | ||
4. Create new target. I suggest to call it Documentation | ||
5. Click on Build Phases and add new Build Phase based on Script | ||
6. Paste the script below into the script window | ||
7. Adjust variables in section "Start Constants" as required | ||
8. Uncomment correct 'target' for your project and comment out another one depending on your project type. | ||
9. Adjust path to appledoc binary and appledoc's command-line switches if required | ||
10. When you ready to generate a docset from your project, build Documentation target. | ||
11. Docset will be installed into new loction and will become available to Xcode immediately. | ||
12. To refresh Quick Help (ALT+Click) and (ALT+double-click) you may need to restart Xcode to refresh its index cache. | ||
|
||
|
||
|
||
#appledoc Xcode script | ||
# Start constants | ||
company="ACME"; | ||
companyID="com.ACME"; | ||
companyURL="http://ACME.com"; | ||
target="iphoneos"; | ||
#target="macosx"; | ||
outputPath="~/help"; | ||
# End constants | ||
/usr/local/bin/appledoc \ | ||
--project-name "${PROJECT_NAME}" \ | ||
--project-company "${company}" \ | ||
--company-id "${companyID}" \ | ||
--docset-atom-filename "${company}.atom" \ | ||
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \ | ||
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \ | ||
--docset-fallback-url "${companyURL}/${company}" \ | ||
--output "${outputPath}" \ | ||
--publish-docset \ | ||
--docset-platform-family "${target}" \ | ||
--logformat xcode \ | ||
--keep-intermediate-files \ | ||
--no-repeat-first-par \ | ||
--no-warn-invalid-crossref \ | ||
--exit-threshold 2 \ | ||
"${PROJECT_DIR}" |
This file contains 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