Skip to content
This repository was archived by the owner on Feb 21, 2019. It is now read-only.

Commit ef7262b

Browse files
antmdantmd
committed
Reinstated doxygen options...but now there is a duplication of functionality with the 'Use headerdoc style' option
2 parents 5253063 + c676f13 commit ef7262b

34 files changed

Lines changed: 2531 additions & 362 deletions

‎.gitignore‎

Lines changed: 161 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,163 @@
1+
#########################
2+
# .gitignore file for Xcode4 / OS X Source projects
3+
#
4+
# Version 2.1
5+
# For latest version, see: http://stackoverflow.com/questions/49478/git-ignore-file-for-xcode-projects
6+
#
7+
# 2013 updates:
8+
# - fixed the broken "save personal Schemes"
9+
# - added line-by-line explanations for EVERYTHING (some were missing)
10+
#
11+
# NB: if you are storing "built" products, this WILL NOT WORK,
12+
# and you should use a different .gitignore (or none at all)
13+
# This file is for SOURCE projects, where there are many extra
14+
# files that we want to exclude
15+
#
16+
#########################
17+
18+
#####
19+
# OS X temporary files that should never be committed
20+
#
21+
# c.f. http://www.westwind.com/reference/os-x/invisibles.html
22+
123
.DS_Store
24+
25+
# c.f. http://www.westwind.com/reference/os-x/invisibles.html
26+
27+
.Trashes
28+
29+
# c.f. http://www.westwind.com/reference/os-x/invisibles.html
30+
31+
*.swp
32+
33+
# *.lock - this is used and abused by many editors for many different things.
34+
# For the main ones I use (e.g. Eclipse), it should be excluded
35+
# from source-control, but YMMV
36+
37+
*.lock
38+
39+
#
40+
# profile - REMOVED temporarily (on double-checking, this seems incorrect; I can't find it in OS X docs?)
41+
#profile
42+
43+
44+
####
45+
# Xcode temporary files that should never be committed
46+
#
47+
# NB: NIB/XIB files still exist even on Storyboard projects, so we want this...
48+
49+
*~.nib
50+
51+
52+
####
53+
# Xcode build files -
54+
#
55+
# NB: slash on the end, so we only remove the FOLDER, not any files that were badly named "DerivedData"
56+
57+
DerivedData/
58+
59+
# NB: slash on the end, so we only remove the FOLDER, not any files that were badly named "build"
60+
61+
build/
62+
63+
64+
#####
65+
# Xcode private settings (window sizes, bookmarks, breakpoints, custom executables, smart groups)
66+
#
67+
# This is complicated:
68+
#
69+
# SOMETIMES you need to put this file in version control.
70+
# Apple designed it poorly - if you use "custom executables", they are
71+
# saved in this file.
72+
# 99% of projects do NOT use those, so they do NOT want to version control this file.
73+
# ..but if you're in the 1%, comment out the line "*.pbxuser"
74+
75+
# .pbxuser: http://lists.apple.com/archives/xcode-users/2004/Jan/msg00193.html
76+
77+
*.pbxuser
78+
79+
# .mode1v3: http://lists.apple.com/archives/xcode-users/2007/Oct/msg00465.html
80+
81+
*.mode1v3
82+
83+
# .mode2v3: http://lists.apple.com/archives/xcode-users/2007/Oct/msg00465.html
84+
85+
*.mode2v3
86+
87+
# .perspectivev3: http://stackoverflow.com/questions/5223297/xcode-projects-what-is-a-perspectivev3-file
88+
89+
*.perspectivev3
90+
91+
# NB: also, whitelist the default ones, some projects need to use these
92+
!default.pbxuser
93+
!default.mode1v3
94+
!default.mode2v3
95+
!default.perspectivev3
96+
97+
98+
####
99+
# Xcode 4 - semi-personal settings
100+
#
101+
#
102+
# OPTION 1: ---------------------------------
103+
# throw away ALL personal settings (including custom schemes!
104+
# - unless they are "shared")
105+
#
106+
# NB: this is exclusive with OPTION 2 below
107+
xcuserdata
108+
109+
# OPTION 2: ---------------------------------
110+
# get rid of ALL personal settings, but KEEP SOME OF THEM
111+
# - NB: you must manually uncomment the bits you want to keep
112+
#
113+
# NB: this *requires* git v1.8.2 or above; you may need to upgrade to latest OS X,
114+
# or manually install git over the top of the OS X version
115+
# NB: this is exclusive with OPTION 1 above
116+
#
117+
#xcuserdata/**/*
118+
119+
# (requires option 2 above): Personal Schemes
120+
#
121+
#!xcuserdata/**/xcschemes/*
122+
123+
####
124+
# XCode 4 workspaces - more detailed
125+
#
126+
# Workspaces are important! They are a core feature of Xcode - don't exclude them :)
127+
#
128+
# Workspace layout is quite spammy. For reference:
129+
#
130+
# /(root)/
131+
# /(project-name).xcodeproj/
132+
# project.pbxproj
133+
# /project.xcworkspace/
134+
# contents.xcworkspacedata
135+
# /xcuserdata/
136+
# /(your name)/xcuserdatad/
137+
# UserInterfaceState.xcuserstate
138+
# /xcsshareddata/
139+
# /xcschemes/
140+
# (shared scheme name).xcscheme
141+
# /xcuserdata/
142+
# /(your name)/xcuserdatad/
143+
# (private scheme).xcscheme
144+
# xcschememanagement.plist
145+
#
146+
#
147+
148+
####
149+
# Xcode 4 - Deprecated classes
150+
#
151+
# Allegedly, if you manually "deprecate" your classes, they get moved here.
152+
#
153+
# We're using source-control, so this is a "feature" that we do not want!
154+
155+
*.moved-aside
156+
157+
####
158+
# UNKNOWN: recommended by others, but I can't discover what these files are
159+
#
160+
# ...none. Everything is now explained.
161+
162+
/VVDocumenter-Xcode.xcodeproj/project.xcworkspace/xcshareddata/
2163
.idea
3-
UserInterfaceState.xcuserstate
4-
build
5-
VVDocumenter-Xcode.xcodeproj/xcuserdata/*.xcuserdatad

‎.travis.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
language: objective-c
1+
language: objective-c
2+
xcode_project: VVDocumenter-Xcode.xcodeproj
3+
xcode_scheme: VVDocumenter-Xcode

‎README.md‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## What is this?
55

6-
Writing document is so important for developing, but it is really painful with Xcode. Think about how much time you are wasting in pressing '*' or '/', and typing the parameters again and again. Now, you can find the method (or any code) you want to document to, and type in `///`, the document will be generated for you and all params and return will be extracted into a Javadoc style, which is compatible with both [appledoc](https://github.com/tomaz/appledoc) and [Doxygen](http://www.stack.nl/~dimitri/doxygen/). You can just fill the inline placeholders to finish your document。
6+
Writing document is so important for developing, but it is really painful with Xcode. Think about how much time you are wasting in pressing '*' or '/', and typing the parameters again and again. Now, you can find the method (or any code) you want to document to, and type in `///`, the document will be generated for you and all params and return will be extracted into a Javadoc style, which is compatible with [appledoc](https://github.com/tomaz/appledoc), [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and [HeaderDoc](https://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html). You can just fill the inline placeholder tokens to finish your document.
77

88
Here is an image which can show what it exactly does.
99

@@ -13,11 +13,11 @@ Here is an image which can show what it exactly does.
1313

1414
Build the `VVDocumenter-Xcode` target in the Xcode project and the plug-in will automatically be installed in `~/Library/Application Support/Developer/Shared/Xcode/Plug-ins`. Relaunch Xcode and type in `///` above any code you want to write a document to.
1515

16-
If you want to use other text beside of `///` to trigger the document insertion, you can find a setting panel by clicking `VVDocument` in the Window menu of Xcode. You can also set using spaces instead of tab in the panel.
16+
If you want to use other text beside of `///` to trigger the document insertion, you can find a setting panel by clicking `VVDocument` in the Window menu of Xcode. You can also find some other useful options there, including setting using spaces instead of tab in the panel or changing the format of generated documentation.
1717

1818
## Xcode version?
1919

20-
This plug-in is developed and tested in Mac OSX 10.8.5 Xcode 4.6.3. It should work in all versions of Xcode 4. If you want to use it in Xcode 5 (DP3 or above), you have to make a liittle change in the plist. This is all what I can say now under the NDA.
20+
This plug-in is developed and tested in Mac OSX 10.8.5 Xcode 5. **The master branch dropped support for Xcode 4. If you want to use it in Xcode 4, please check out the [Xcode4 branch](https://github.com/onevcat/VVDocumenter-Xcode/tree/Xcode4).** In Xcode 5, Apple added an UUID-verification to all plugins to ensure the stability when Xcode gets updated. The value of DVTPlugInCompatibilityUUIDs in project plist should contains current UUID of Xcode version, or the plugin does not work. I have added a pre-actions script in scheme to set it for you. **Once you update your Xcode, the plugin would be invalid and you should check the newest version and built it again.**
2121

2222
The default deployment target is 10.8. If you want to use it in a earlier OS version, you should change OS X Deployment Target (in project info setting) to your system version.
2323

@@ -32,17 +32,24 @@ If you have modified these two shortcuts in your Xcode, the newset version of th
3232

3333
And there are a set of code type I hope to support, but now I just finished some of them.
3434

35-
* Objc Method (Done)
36-
* C Function (Done)
37-
* Macro (Done)
38-
* Property (Done)
39-
* Variable (Done)
40-
* Enum (To do)
35+
* ~~Objc Method (Done)~~
36+
* ~~C Function (Done)~~
37+
* ~~Macro (Done)~~
38+
* ~~Property (Done)~~
39+
* ~~Variable (Done)~~
40+
* ~~NS_Enum (Done)~~
41+
* ~~NS_OPTIONS (Done)~~
4142
* Struct (To do)
4243
* Union (To do)
4344

4445
Now the docs for to-do types will be generated only with a basic description (which is the same as Property and Variable).
4546

47+
## Contributors
48+
49+
Thanks for all contributors of this project.
50+
51+
[@idpaterson](https://github.com/idpaterson) [@nickskull](https://github.com/nickskull) [@Ahti](https://github.com/Ahti) [@ilg](https://github.com/ilg) [@zxhfirefox](https://github.com/zxhfirefox) [@xlchen](https://github.com/xlchen)
52+
4653
## License
4754

4855
VVDocumenter is published under MIT License

0 commit comments

Comments
 (0)