jazzy 0.0.3 → 0.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/DEV_README.md +35 -0
- data/Gemfile +11 -0
- data/Gemfile.lock +32 -0
- data/README.md +7 -29
- data/bin/generate_swift_header.sh +14 -0
- data/jazzy.gemspec +3 -3
- data/lib/jazzy.rb +146 -153
- data/lib/jazzy/klass.mustache +137 -312
- data/lib/jazzy/klass.rb +0 -4
- data/lib/jazzy/partials/klass-method.mustache +68 -82
- data/lib/jazzy/partials/klass-overview.mustache +2 -2
- data/lib/jazzy/partials/klass-property.mustache +40 -51
- data/parser/ASTDump.xcodeproj/project.pbxproj +21 -8
- data/parser/clang-c/Index.h +17 -1
- data/{parser/ASTDump → sample}/JAZMusician.h +1 -1
- data/{parser/ASTDump → sample}/JAZMusician.m +0 -0
- data/sample/Musician.swift +37 -0
- data/screenshot.jpg +0 -0
- metadata +13 -7
- data/bin/SwiftHeader +0 -22
data/lib/jazzy/klass.rb
CHANGED
|
@@ -1,84 +1,70 @@
|
|
|
1
|
-
<li class="item symbol"
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
<
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
<
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
1
|
+
<li class="item symbol">
|
|
2
|
+
<div class="task-group-term">
|
|
3
|
+
<code class="code-voice">
|
|
4
|
+
<a name="{{declaration.objc}}"></a><a name="{{usr}}"></a><a name="{{declaration.swift}}"></a>
|
|
5
|
+
<a class="x-instance-method Swift" href="#{{declaration.swift}}" title="{{abstract}}">{{name.swift}}</a>
|
|
6
|
+
<a class="x-instance-method Objective-C" href="#{{declaration.objc}}" title="{{abstract}}">{{name.objc}}</a>
|
|
7
|
+
</code>
|
|
8
|
+
</div>
|
|
9
|
+
<div class="height-container hidden">
|
|
10
|
+
<div class="pointy-thing-container"></div>
|
|
11
|
+
<section class="section instance-method">
|
|
12
|
+
<div class="pointy-thing"></div>
|
|
13
|
+
<div class="abstract">
|
|
14
|
+
{{{rendered_abstract}}}
|
|
15
|
+
</div>
|
|
16
|
+
<div class="declaration">
|
|
17
|
+
<h4>Declaration</h4>
|
|
18
|
+
<div class="Swift">
|
|
19
|
+
<p class="aside-title">Swift</p>
|
|
20
|
+
<p class="para">
|
|
21
|
+
<code class="code-voice">{{declaration.swift}}</code>
|
|
22
|
+
</p>
|
|
23
|
+
</div>
|
|
24
|
+
<div class="Objective-C">
|
|
25
|
+
<p class="aside-title">Objective-C</p>
|
|
26
|
+
<p class="para">
|
|
27
|
+
<code class="code-voice">{{declaration.objc}}</code>
|
|
28
|
+
</p>
|
|
29
|
+
</div>
|
|
30
|
+
</div>
|
|
31
|
+
<div class="parameters">
|
|
32
|
+
<h4>Parameters</h4>
|
|
33
|
+
<table class="graybox" border="0" cellspacing="0" cellpadding="5">
|
|
34
|
+
<tbody>
|
|
35
|
+
{{#parameters}}
|
|
36
|
+
<tr>
|
|
37
|
+
<td scope="row">
|
|
38
|
+
<code class="code-voice">
|
|
39
|
+
<em class="term">{{name}}</em>
|
|
40
|
+
</code>
|
|
41
|
+
</td>
|
|
42
|
+
<td>
|
|
43
|
+
<div class="definition">
|
|
44
|
+
<p class="para">
|
|
45
|
+
{{discussion}}
|
|
46
|
+
</p>
|
|
29
47
|
</div>
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
<p class="para">
|
|
53
|
-
{{discussion}}
|
|
54
|
-
</p>
|
|
55
|
-
|
|
56
|
-
</div>
|
|
57
|
-
</td>
|
|
58
|
-
</tr>
|
|
59
|
-
{{/parameters}}
|
|
60
|
-
</tbody>
|
|
61
|
-
</table>
|
|
62
|
-
</div>
|
|
63
|
-
|
|
64
|
-
<div class="result-description">
|
|
65
|
-
<h4>Return Value</h4>
|
|
66
|
-
<p class="para">
|
|
67
|
-
{{result}}
|
|
68
|
-
</p>
|
|
69
|
-
|
|
70
|
-
</div>
|
|
71
|
-
|
|
72
|
-
<div class="discussion">
|
|
73
|
-
<h4>Discussion</h4>
|
|
74
|
-
{{{rendered_discussion}}}
|
|
75
|
-
</div>
|
|
76
|
-
|
|
77
|
-
<div class="availability">
|
|
78
|
-
<h4>Availability</h4>
|
|
79
|
-
<p class="para availability-item">Available in iOS 8.0 and later.</p>
|
|
80
|
-
</div>
|
|
81
|
-
|
|
82
|
-
</section>
|
|
83
|
-
</div>
|
|
48
|
+
</td>
|
|
49
|
+
</tr>
|
|
50
|
+
{{/parameters}}
|
|
51
|
+
</tbody>
|
|
52
|
+
</table>
|
|
53
|
+
</div>
|
|
54
|
+
<div class="result-description">
|
|
55
|
+
<h4>Return Value</h4>
|
|
56
|
+
<p class="para">
|
|
57
|
+
{{result}}
|
|
58
|
+
</p>
|
|
59
|
+
</div>
|
|
60
|
+
<div class="discussion">
|
|
61
|
+
<h4>Discussion</h4>
|
|
62
|
+
{{{rendered_discussion}}}
|
|
63
|
+
</div>
|
|
64
|
+
<div class="availability">
|
|
65
|
+
<h4>Availability</h4>
|
|
66
|
+
<p class="para availability-item">Available in iOS 8.0 and later.</p>
|
|
67
|
+
</div>
|
|
68
|
+
</section>
|
|
69
|
+
</div>
|
|
84
70
|
</li>
|
|
@@ -1,52 +1,41 @@
|
|
|
1
|
-
<li class="item symbol"
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
<div class="
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
{{{rendered_discussion}}}
|
|
42
|
-
|
|
43
|
-
</div>
|
|
44
|
-
|
|
45
|
-
<div class="availability">
|
|
46
|
-
<h4>Availability</h4>
|
|
47
|
-
<p class="para availability-item">Available in iOS 8.0 and later.</p>
|
|
48
|
-
</div>
|
|
49
|
-
|
|
50
|
-
</section>
|
|
51
|
-
</div>
|
|
1
|
+
<li class="item symbol">
|
|
2
|
+
<div class="task-group-term">
|
|
3
|
+
<code class="code-voice">
|
|
4
|
+
<a name="{{declaration.objc}}"></a><a name="{{usr}}"></a><a name="{{declaration.swift}}"></a>
|
|
5
|
+
<a class="x-api-property-task-list Swift" href="#{{declaration.swift}}" title="{{abstract}}">{{name.swift}}</a>
|
|
6
|
+
<a class="x-api-property-task-list Objective-C" href="#{{declaration.objc}}" title="{{abstract}}">{{name.objc}}</a>
|
|
7
|
+
</code>
|
|
8
|
+
</div>
|
|
9
|
+
<div class="height-container">
|
|
10
|
+
<div class="pointy-thing-container"></div>
|
|
11
|
+
<section class="section property-obj-c">
|
|
12
|
+
<div class="pointy-thing"></div>
|
|
13
|
+
<div class="abstract">
|
|
14
|
+
{{{rendered_abstract}}}
|
|
15
|
+
</div>
|
|
16
|
+
<div class="declaration">
|
|
17
|
+
<h4>Declaration</h4>
|
|
18
|
+
<div class="Swift">
|
|
19
|
+
<p class="aside-title">Swift</p>
|
|
20
|
+
<p class="para">
|
|
21
|
+
<code class="code-voice">
|
|
22
|
+
{{declaration.swift}}
|
|
23
|
+
</code>
|
|
24
|
+
</p>
|
|
25
|
+
</div>
|
|
26
|
+
<div class="Objective-C">
|
|
27
|
+
<p class="aside-title">Objective-C</p>
|
|
28
|
+
<p class="para">
|
|
29
|
+
<code class="code-voice">
|
|
30
|
+
{{declaration.objc}}
|
|
31
|
+
</code>
|
|
32
|
+
</p>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
<div class="discussion">
|
|
36
|
+
<h4>Discussion</h4>
|
|
37
|
+
{{{rendered_discussion}}}
|
|
38
|
+
</div>
|
|
39
|
+
</section>
|
|
40
|
+
</div>
|
|
52
41
|
</li>
|
|
@@ -8,9 +8,10 @@
|
|
|
8
8
|
|
|
9
9
|
/* Begin PBXBuildFile section */
|
|
10
10
|
E80E07DE194125F400E2B0B5 /* libclang.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = E80E07DD194125F400E2B0B5 /* libclang.dylib */; settings = {ATTRIBUTES = (Required, ); }; };
|
|
11
|
-
E80E07FA1941481800E2B0B5 /* JAZMusician.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = E80E07F6194147EA00E2B0B5 /* JAZMusician.h */; };
|
|
12
11
|
E80E07FC1941488500E2B0B5 /* main.cpp in Sources */ = {isa = PBXBuildFile; fileRef = E80E07D4194125DB00E2B0B5 /* main.cpp */; };
|
|
13
|
-
|
|
12
|
+
E846E32819654CAC00B5569D /* JAZMusician.m in Sources */ = {isa = PBXBuildFile; fileRef = E846E32619654CAC00B5569D /* JAZMusician.m */; };
|
|
13
|
+
E846E32919654CAC00B5569D /* Musician.swift in Sources */ = {isa = PBXBuildFile; fileRef = E846E32719654CAC00B5569D /* Musician.swift */; };
|
|
14
|
+
E846E32A19654CBD00B5569D /* JAZMusician.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = E846E32519654CAC00B5569D /* JAZMusician.h */; };
|
|
14
15
|
/* End PBXBuildFile section */
|
|
15
16
|
|
|
16
17
|
/* Begin PBXCopyFilesBuildPhase section */
|
|
@@ -20,7 +21,7 @@
|
|
|
20
21
|
dstPath = "";
|
|
21
22
|
dstSubfolderSpec = 16;
|
|
22
23
|
files = (
|
|
23
|
-
|
|
24
|
+
E846E32A19654CBD00B5569D /* JAZMusician.h in CopyFiles */,
|
|
24
25
|
);
|
|
25
26
|
runOnlyForDeploymentPostprocessing = 0;
|
|
26
27
|
};
|
|
@@ -37,8 +38,9 @@
|
|
|
37
38
|
E80E07EE1941280000E2B0B5 /* Documentation.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Documentation.h; sourceTree = "<group>"; };
|
|
38
39
|
E80E07EF1941280000E2B0B5 /* Index.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Index.h; sourceTree = "<group>"; };
|
|
39
40
|
E80E07F11941280000E2B0B5 /* Platform.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = Platform.h; sourceTree = "<group>"; };
|
|
40
|
-
|
|
41
|
-
|
|
41
|
+
E846E32519654CAC00B5569D /* JAZMusician.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = JAZMusician.h; sourceTree = "<group>"; };
|
|
42
|
+
E846E32619654CAC00B5569D /* JAZMusician.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = JAZMusician.m; sourceTree = "<group>"; };
|
|
43
|
+
E846E32719654CAC00B5569D /* Musician.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Musician.swift; sourceTree = "<group>"; };
|
|
42
44
|
/* End PBXFileReference section */
|
|
43
45
|
|
|
44
46
|
/* Begin PBXFrameworksBuildPhase section */
|
|
@@ -56,6 +58,7 @@
|
|
|
56
58
|
E80E07C8194125DB00E2B0B5 = {
|
|
57
59
|
isa = PBXGroup;
|
|
58
60
|
children = (
|
|
61
|
+
E846E32419654CAC00B5569D /* sample */,
|
|
59
62
|
E80E07E91941280000E2B0B5 /* clang-c */,
|
|
60
63
|
E80E07DD194125F400E2B0B5 /* libclang.dylib */,
|
|
61
64
|
E80E07D3194125DB00E2B0B5 /* ASTDump */,
|
|
@@ -74,8 +77,6 @@
|
|
|
74
77
|
E80E07D3194125DB00E2B0B5 /* ASTDump */ = {
|
|
75
78
|
isa = PBXGroup;
|
|
76
79
|
children = (
|
|
77
|
-
E80E07F6194147EA00E2B0B5 /* JAZMusician.h */,
|
|
78
|
-
E80E07F7194147EA00E2B0B5 /* JAZMusician.m */,
|
|
79
80
|
E80E07D4194125DB00E2B0B5 /* main.cpp */,
|
|
80
81
|
);
|
|
81
82
|
path = ASTDump;
|
|
@@ -95,6 +96,17 @@
|
|
|
95
96
|
path = "clang-c";
|
|
96
97
|
sourceTree = "<group>";
|
|
97
98
|
};
|
|
99
|
+
E846E32419654CAC00B5569D /* sample */ = {
|
|
100
|
+
isa = PBXGroup;
|
|
101
|
+
children = (
|
|
102
|
+
E846E32519654CAC00B5569D /* JAZMusician.h */,
|
|
103
|
+
E846E32619654CAC00B5569D /* JAZMusician.m */,
|
|
104
|
+
E846E32719654CAC00B5569D /* Musician.swift */,
|
|
105
|
+
);
|
|
106
|
+
name = sample;
|
|
107
|
+
path = ../sample;
|
|
108
|
+
sourceTree = "<group>";
|
|
109
|
+
};
|
|
98
110
|
/* End PBXGroup section */
|
|
99
111
|
|
|
100
112
|
/* Begin PBXNativeTarget section */
|
|
@@ -147,8 +159,9 @@
|
|
|
147
159
|
isa = PBXSourcesBuildPhase;
|
|
148
160
|
buildActionMask = 2147483647;
|
|
149
161
|
files = (
|
|
150
|
-
|
|
162
|
+
E846E32819654CAC00B5569D /* JAZMusician.m in Sources */,
|
|
151
163
|
E80E07FC1941488500E2B0B5 /* main.cpp in Sources */,
|
|
164
|
+
E846E32919654CAC00B5569D /* Musician.swift in Sources */,
|
|
152
165
|
);
|
|
153
166
|
runOnlyForDeploymentPostprocessing = 0;
|
|
154
167
|
};
|
data/parser/clang-c/Index.h
CHANGED
|
@@ -2139,7 +2139,23 @@ enum CXCursorKind {
|
|
|
2139
2139
|
*/
|
|
2140
2140
|
CXCursor_OMPSimdDirective = 233,
|
|
2141
2141
|
|
|
2142
|
-
|
|
2142
|
+
/** \brief OpenMP for directive.
|
|
2143
|
+
*/
|
|
2144
|
+
CXCursor_OMPForDirective = 234,
|
|
2145
|
+
|
|
2146
|
+
/** \brief OpenMP sections directive.
|
|
2147
|
+
*/
|
|
2148
|
+
CXCursor_OMPSectionsDirective = 235,
|
|
2149
|
+
|
|
2150
|
+
/** \brief OpenMP section directive.
|
|
2151
|
+
*/
|
|
2152
|
+
CXCursor_OMPSectionDirective = 236,
|
|
2153
|
+
|
|
2154
|
+
/** \brief OpenMP single directive.
|
|
2155
|
+
*/
|
|
2156
|
+
CXCursor_OMPSingleDirective = 237,
|
|
2157
|
+
|
|
2158
|
+
CXCursor_LastStmt = CXCursor_OMPSingleDirective,
|
|
2143
2159
|
|
|
2144
2160
|
/**
|
|
2145
2161
|
* \brief Cursor that represents the translation unit itself.
|
|
File without changes
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Musician.swift
|
|
3
|
+
// JazzyApp
|
|
4
|
+
//
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
Musician models jazz musicians.
|
|
8
|
+
From Ellington to Marsalis, this class has you covered.
|
|
9
|
+
*/
|
|
10
|
+
class Musician {
|
|
11
|
+
/**
|
|
12
|
+
The name of the musician. i.e. "John Coltrane"
|
|
13
|
+
*/
|
|
14
|
+
var name: String
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
The year the musician was born. i.e. 1926
|
|
18
|
+
*/
|
|
19
|
+
var birthyear: UInt
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
Initialize a Musician.
|
|
23
|
+
Don't forget to have a name and a birthyear.
|
|
24
|
+
|
|
25
|
+
@warning Jazz can be addicting.
|
|
26
|
+
Please be careful out there.
|
|
27
|
+
|
|
28
|
+
@param name The name of the musician.
|
|
29
|
+
@param birthyear The year the musician was born.
|
|
30
|
+
|
|
31
|
+
@return An initialized Musician instance.
|
|
32
|
+
*/
|
|
33
|
+
init(name: String, birthyear: UInt) {
|
|
34
|
+
self.name = name
|
|
35
|
+
self.birthyear = birthyear
|
|
36
|
+
}
|
|
37
|
+
}
|
data/screenshot.jpg
ADDED
|
Binary file
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jazzy
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- JP Simard, Tim Anglade
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2014-
|
|
11
|
+
date: 2014-07-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: mustache
|
|
@@ -96,18 +96,21 @@ dependencies:
|
|
|
96
96
|
version: '0'
|
|
97
97
|
description: A soulful way to generate docs for Swift & Objective-C
|
|
98
98
|
email:
|
|
99
|
-
- jp@
|
|
99
|
+
- jp@realm.io
|
|
100
100
|
executables:
|
|
101
101
|
- jazzy
|
|
102
102
|
extensions: []
|
|
103
103
|
extra_rdoc_files: []
|
|
104
104
|
files:
|
|
105
105
|
- ".gitignore"
|
|
106
|
+
- DEV_README.md
|
|
107
|
+
- Gemfile
|
|
108
|
+
- Gemfile.lock
|
|
106
109
|
- LICENSE
|
|
107
110
|
- README.md
|
|
108
111
|
- Rakefile
|
|
109
112
|
- bin/ASTDump
|
|
110
|
-
- bin/
|
|
113
|
+
- bin/generate_swift_header.sh
|
|
111
114
|
- bin/jazzy
|
|
112
115
|
- jazzy.gemspec
|
|
113
116
|
- lib/assets/CSS/style-1.1.15.css
|
|
@@ -153,8 +156,6 @@ files:
|
|
|
153
156
|
- parser/ASTDump.xcodeproj/project.xcworkspace/xcuserdata/ta.xcuserdatad/UserInterfaceState.xcuserstate
|
|
154
157
|
- parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/ASTDump.xcscheme
|
|
155
158
|
- parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/xcschememanagement.plist
|
|
156
|
-
- parser/ASTDump/JAZMusician.h
|
|
157
|
-
- parser/ASTDump/JAZMusician.m
|
|
158
159
|
- parser/ASTDump/main.cpp
|
|
159
160
|
- parser/clang-c/BuildSystem.h
|
|
160
161
|
- parser/clang-c/CXCompilationDatabase.h
|
|
@@ -163,6 +164,10 @@ files:
|
|
|
163
164
|
- parser/clang-c/Documentation.h
|
|
164
165
|
- parser/clang-c/Index.h
|
|
165
166
|
- parser/clang-c/Platform.h
|
|
167
|
+
- sample/JAZMusician.h
|
|
168
|
+
- sample/JAZMusician.m
|
|
169
|
+
- sample/Musician.swift
|
|
170
|
+
- screenshot.jpg
|
|
166
171
|
homepage: http://github.com/realm/jazzy
|
|
167
172
|
licenses:
|
|
168
173
|
- MIT
|
|
@@ -183,8 +188,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
183
188
|
version: '0'
|
|
184
189
|
requirements: []
|
|
185
190
|
rubyforge_project:
|
|
186
|
-
rubygems_version: 2.
|
|
191
|
+
rubygems_version: 2.2.2
|
|
187
192
|
signing_key:
|
|
188
193
|
specification_version: 4
|
|
189
194
|
summary: A soulful way to generate docs for Swift & Objective-C
|
|
190
195
|
test_files: []
|
|
196
|
+
has_rdoc:
|