Skip to content
This repository
Newer
Older
100644 105 lines (62 sloc) 9.38 kb
5d5f58e1 »
2010-12-14 Added default readme file.
1 About appledoc
2 ==============
3
4 appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It's designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and browsable Xcode documentation set. Although there are several tools that can create HTML documentation for Objective-C, all of those know to me fall short in meeting the minimum of goals described below.
5
6 Main goals of appledoc:
7
8 - Human-readable source code comments.
9 - Simple cross references to objects and members.
10 - Generate Apple-like source code HTML documentation.
11 - Generate and install fully indexed and browsable Xcode documentation set.
12 - Single tool to drive generation from source code parsing to documentation set installation.
13 - Easily customizable output.
14 - 100% Objective-C implementation for easy debugging.
15
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
16 To make your experience with appledoc as smooth as possible, we warmly suggest reading this whole document as well as all online documentation mentioned in "using appledoc" section below!
5d5f58e1 »
2010-12-14 Added default readme file.
17
1b9a0bd0 »
2011-01-26 IMPORTANT: Updated license to modified BSD license!
18 Usage of appledoc is allowed under the terms listed in LICENSE section at the bottom of this file!
19
022d6740 »
2011-01-17 Added twitter name to readme.
20 Want to keep updated? Follow us on Twitter - [@gentlebytes](http://twitter.com/gentlebytes).
21
5d5f58e1 »
2010-12-14 Added default readme file.
22
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
23 Quick install
24 =============
25
26 The recommended way is to clone GitHub project and compile the tool from Xcode. As cloning GitHub project will create the link to the main repository, it greatly simplifies future upgrading too. To install, type the following in the Terminal:
5d5f58e1 »
2010-12-14 Added default readme file.
27
28 git clone git://github.com/tomaz/appledoc.git
29
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
30 This creates appledoc directory. Within you can find appledoc.xcodeproj Xcode project; open it and compile appledoc target - this should work out of the box, however your system must meet minimum system requirements, see below. I recommend you copy resulting appledoc executable from build directory to one of the directories in your path (`echo $PATH`) to make it easily accessible.
31
32 Before running the tool, you need to copy all required template files from Templates subdirectory to one of the expected locations:
5d5f58e1 »
2010-12-14 Added default readme file.
33
34 - ~/Library/Application Support/appledoc
35 - ~/.appledoc
36
db626c32 »
2011-01-12 Changed readme file to include preffered mail and cleaned up text.
37
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
38 Using appledoc
39 ==============
5d5f58e1 »
2010-12-14 Added default readme file.
40
db626c32 »
2011-01-12 Changed readme file to include preffered mail and cleaned up text.
41 Use `appledoc --help` to see the list of all command line switches. Read more about appledoc on [appledoc site](http://appledoc.gentlebytes.com) and check short help, documentation and tips on [appledoc's GitHub page](http://tomaz.github.com/appledoc/). Use [appledoc issues page](https://github.com/tomaz/appledoc/issues) to submit bug and feature requests. Before submitting read through open issues to see if the issue is already there and vote on it or add a comment. If you're not using development branch (see installation tips below) also check closed issues as your request may have already been covered but is not yet on master branch!
5d5f58e1 »
2010-12-14 Added default readme file.
42
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
43 Installation tips
44 -----------------
5d5f58e1 »
2010-12-14 Added default readme file.
45
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
46 To keep up to date, just go to Terminal and cd into appledoc directory, issue `git pull` and recompile appledoc.xcodeproj. Don't forget to overwrite appledoc executable you've copied to $PATH :)
5d5f58e1 »
2010-12-14 Added default readme file.
47
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
48 If you've used installation procedure described above in "quick install" section, you're using appledoc on it's master branch. This gives you most stable version available, however it doesn't include all the latest bug fixes and updates. In fact, all of the work on appledoc happens on development branch and is then merged to master branch from time to time. If you'd like to be updated as frequently as possible, you can switch to development branch. We keep this branch very stable too, so you should be fine using it. Switching to development branch only requires one additional step after cloning (this guide includes clone command, if you've already cloned appledoc, skip the first one):
49
726c8735 »
2011-01-03 Fixed readme file example for cloning development branch.
50 git clone git://github.com/tomaz/appledoc.git
51 cd appledoc
52 git checkout --track origin/development
5d5f58e1 »
2010-12-14 Added default readme file.
53
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
54 You have now switched to development branch, which you can confirm by running `git branch`. You can update using the same method described above (i.e. `git pull`).
55
56 If you also want to compile and run AppledocTests (unit tests) target, you need to copy all the frameworks indicated within Libraries & Frameworks group to shared frameworks directory before building unit tests target! This is not required for building the appledoc tool itself.
57
58 Troubleshooting
59 ---------------
60
61 Have problems? This is what you can do to troubleshoot:
62
63 1. Make sure you have the latest appledoc version, prefferably on development branch. Try `git pull` and run with latest version again. If you're working with master branch, use instructions above to switch to development branch and see if it fixes your issue.
64 2. Increase verbosity level with `--verbose 3` command line switch. You can progressively increment verbosity up to 6 with each level giving you more detailed information. As this will give you a lot more information, you may want to concentrate only on specific set of source files you have problem with. Note that increasing verbosity will result in slower performance so using levels above 4 for every day use is not recommended.
65 3. Appledoc is open source project! You have all the source code available, so run it from Xcode. You can setup Xcode to pass the desired command line arguments and add breakpoints to help you isolate your issue. If you feel you'd like to contribute more to community, you are welcome to fork the project on GitHub and add features to it. Keep us posted so we can add these features to main repository as well - include unit tests if possible.
db626c32 »
2011-01-12 Changed readme file to include preffered mail and cleaned up text.
66 4. If you think you found a bug or want to request new feature, go to [appledoc issues page](https://github.com/tomaz/appledoc/issues). First read existing issues to see if there is already a request there (if you're using master branch, also read closed issues as your request may have already been covered but isn't yet merged on master branch). You can vote on existing requests to help us decide which features to concetrate on or you can add a comment to aid in solving it. If you don't find the request there, create a new issue; include parts of source files that give you problems if possible and/or description or steps that lead to it.
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
67 5. If you're having problems with some of your source files and don't want to publish them online, you can contact us through email below. We'll do our best to help you out, but bear in mind appledoc is not commercial product; it's created and maintaned in our spare time, so resources are limited.
68
1b9a0bd0 »
2011-01-26 IMPORTANT: Updated license to modified BSD license!
69 Developer notes
70 ---------------
71
72 If you wish to contribute, see Developer Notes file for short overview of how appledoc works internally.
73
74
e5e520e1 »
2011-01-03 Reorganized and updated readme file with troubleshooting information.…
75 Minimum system requirements
76 ---------------------------
77
78 - Xcode 3.2 or greater for compiling
79 - OS X 10.6 for running
5d5f58e1 »
2010-12-14 Added default readme file.
80
81
1b9a0bd0 »
2011-01-26 IMPORTANT: Updated license to modified BSD license!
82 LICENSE
5d5f58e1 »
2010-12-14 Added default readme file.
83 =======
84
1b9a0bd0 »
2011-01-26 IMPORTANT: Updated license to modified BSD license!
85 appledoc is licensed with modified BSD license. In plain language: you're allowed to do whatever you wish with the code, modify, redistribute, embed in your products (free or commercial), but you must include copyright, terms of usage and disclaimer as stated in the license, the same way as any other BSD licensed code. You can of course use documentation generated by appledoc for your products (free or commercial), but you must attribute appledoc either in documentation itself or other appropriate place such as your website.
86
87 If for whatever reason you cannot agree to these terms, contact us through contact form on [our about page](http://gentlebytes.com/about), we'll do our best to help you out you out and find a workable solution!
88
89
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
90 Copyright (c) 2009-2011, Gentle Bytes
91 All rights reserved.
1b9a0bd0 »
2011-01-26 IMPORTANT: Updated license to modified BSD license!
92
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
93 Redistribution and use in source, binary forms and generated documentation, with or without modification, are permitted provided that the following conditions are met:
1b9a0bd0 »
2011-01-26 IMPORTANT: Updated license to modified BSD license!
94
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
95 - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
5d5f58e1 »
2010-12-14 Added default readme file.
96
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
97 - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
5d5f58e1 »
2010-12-14 Added default readme file.
98
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
99 - Redistributions of documentation generated by appledoc must include attribution to appledoc, either in documentation itself or other appropriate media.
5d5f58e1 »
2010-12-14 Added default readme file.
100
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
101 - Neither the name of the appledoc, Gentle Bytes nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
5d5f58e1 »
2010-12-14 Added default readme file.
102
f4626863 »
2011-01-26 Updated licence format in readme to allow word wrapping.
103 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
5d5f58e1 »
2010-12-14 Added default readme file.
104
db626c32 »
2011-01-12 Changed readme file to include preffered mail and cleaned up text.
105 Gentle Bytes appledoc@gentlebytes.com
Something went wrong with that request. Please try again.