@@ -66,114 +66,114 @@ class ApidocDirectiveSpec extends MarkdownBaseSpec {
66
66
)
67
67
68
68
" Apidoc directive" should " generate markdown correctly when there is only one match" in {
69
- markdown(" @apidoc[Envelope]" ) shouldEqual
70
- html(
71
- """ <p><span class="group-scala">
72
- |<a href="https://doc.akka.io/api/akka/2.5/akka/dispatch/Envelope.html">Envelope</a></span><span class="group-java">
73
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/dispatch/Envelope.html">Envelope</a></span>
74
- |</p>""" .stripMargin
75
- )
76
- }
69
+ markdown(" @apidoc[Envelope]" ) shouldEqual
70
+ html(
71
+ """ <p><span class="group-scala">
72
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/dispatch/Envelope.html">Envelope</a></span><span class="group-java">
73
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/dispatch/Envelope.html">Envelope</a></span>
74
+ |</p>""" .stripMargin
75
+ )
76
+ }
77
77
78
78
it should " throw an exception when there is no match" in {
79
- val thrown = the[IllegalStateException ] thrownBy markdown(" @apidoc[ThereIsNoSuchClass]" )
80
- thrown.getMessage shouldEqual
81
- " No matches found for ThereIsNoSuchClass"
82
- }
79
+ val thrown = the[IllegalStateException ] thrownBy markdown(" @apidoc[ThereIsNoSuchClass]" )
80
+ thrown.getMessage shouldEqual
81
+ " No matches found for ThereIsNoSuchClass"
82
+ }
83
83
84
84
it should " generate markdown correctly when 2 matches found and their package names include javadsl/scaladsl" in {
85
- markdown(" @apidoc[Flow]" ) shouldEqual
86
- html(
87
- """ <p><span class="group-java">
88
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow</a></span><span class="group-scala">
89
- |<a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Flow.html">Flow</a></span>
90
- |</p>""" .stripMargin
91
- )
92
- }
85
+ markdown(" @apidoc[Flow]" ) shouldEqual
86
+ html(
87
+ """ <p><span class="group-java">
88
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow</a></span><span class="group-scala">
89
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Flow.html">Flow</a></span>
90
+ |</p>""" .stripMargin
91
+ )
92
+ }
93
93
94
94
it should " allow linking to a typed class that is also present in classic" in {
95
- markdown(" @apidoc[typed.*.Replicator$]" ) shouldEqual
96
- html(
97
- """ <p><span class="group-scala">
98
- |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/ddata/typed/scaladsl/Replicator$.html">Replicator</a></span><span class="group-java">
99
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/cluster/ddata/typed/javadsl/Replicator.html">Replicator</a></span>
100
- |</p>""" .stripMargin
101
- )
102
- }
95
+ markdown(" @apidoc[typed.*.Replicator$]" ) shouldEqual
96
+ html(
97
+ """ <p><span class="group-scala">
98
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/ddata/typed/scaladsl/Replicator$.html">Replicator</a></span><span class="group-java">
99
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/cluster/ddata/typed/javadsl/Replicator.html">Replicator</a></span>
100
+ |</p>""" .stripMargin
101
+ )
102
+ }
103
103
104
104
it should " allow linking to a classic class that is also present in typed" in {
105
- markdown(" @apidoc[ddata.Replicator$]" ) shouldEqual
106
- html(
107
- """ <p><span class="group-scala">
108
- |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/ddata/Replicator$.html">Replicator</a></span><span class="group-java">
109
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/cluster/ddata/Replicator.html">Replicator</a></span>
110
- |</p>""" .stripMargin
111
- )
112
- }
105
+ markdown(" @apidoc[ddata.Replicator$]" ) shouldEqual
106
+ html(
107
+ """ <p><span class="group-scala">
108
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/ddata/Replicator$.html">Replicator</a></span><span class="group-java">
109
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/cluster/ddata/Replicator.html">Replicator</a></span>
110
+ |</p>""" .stripMargin
111
+ )
112
+ }
113
113
114
114
it should " throw an exception when two matches found but javadsl/scaladsl is not in their packages" in {
115
- val thrown = the[IllegalStateException ] thrownBy markdown(" @apidoc[ActorRef]" )
116
- thrown.getMessage shouldEqual
117
- " 2 matches found for ActorRef, but not javadsl/scaladsl: akka.actor.ActorRef, akka.actor.typed.ActorRef. You may want to use the fully qualified class name as @apidoc[fqcn] instead of @apidoc[ActorRef]."
118
- }
115
+ val thrown = the[IllegalStateException ] thrownBy markdown(" @apidoc[ActorRef]" )
116
+ thrown.getMessage shouldEqual
117
+ " 2 matches found for ActorRef, but not javadsl/scaladsl: akka.actor.ActorRef, akka.actor.typed.ActorRef. You may want to use the fully qualified class name as @apidoc[fqcn] instead of @apidoc[ActorRef]."
118
+ }
119
119
120
120
it should " generate markdown correctly when fully qualified class name (fqcn) is specified as @apidoc[fqcn]" in {
121
- markdown(" @apidoc[akka.actor.ActorRef]" ) shouldEqual
122
- html(
123
- """ <p><span class="group-scala">
124
- |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/ActorRef.html">ActorRef</a></span><span class="group-java">
125
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/actor/ActorRef.html">ActorRef</a></span>
126
- |</p>""" .stripMargin
127
- )
128
- }
121
+ markdown(" @apidoc[akka.actor.ActorRef]" ) shouldEqual
122
+ html(
123
+ """ <p><span class="group-scala">
124
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/ActorRef.html">ActorRef</a></span><span class="group-java">
125
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/actor/ActorRef.html">ActorRef</a></span>
126
+ |</p>""" .stripMargin
127
+ )
128
+ }
129
129
130
130
it should " find a class by partiql fqdn" in {
131
- markdown(" @apidoc[actor.typed.ActorRef]" ) shouldEqual
132
- html(
133
- """ <p><span class="group-scala">
134
- |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/typed/ActorRef.html">ActorRef</a></span><span class="group-java">
135
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/actor/typed/ActorRef.html">ActorRef</a></span>
136
- |</p>""" .stripMargin
137
- )
138
- }
131
+ markdown(" @apidoc[actor.typed.ActorRef]" ) shouldEqual
132
+ html(
133
+ """ <p><span class="group-scala">
134
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/actor/typed/ActorRef.html">ActorRef</a></span><span class="group-java">
135
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/actor/typed/ActorRef.html">ActorRef</a></span>
136
+ |</p>""" .stripMargin
137
+ )
138
+ }
139
139
140
140
it should " generate markdown correctly for a companion object" in {
141
- markdown(" @apidoc[ClusterClient$]" ) shouldEqual
142
- html(
143
- """ <p><span class="group-scala">
144
- |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/client/ClusterClient$.html">ClusterClient</a></span><span class="group-java">
145
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/cluster/client/ClusterClient.html">ClusterClient</a></span>
146
- |</p>""" .stripMargin
147
- )
148
- }
141
+ markdown(" @apidoc[ClusterClient$]" ) shouldEqual
142
+ html(
143
+ """ <p><span class="group-scala">
144
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/cluster/client/ClusterClient$.html">ClusterClient</a></span><span class="group-java">
145
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/cluster/client/ClusterClient.html">ClusterClient</a></span>
146
+ |</p>""" .stripMargin
147
+ )
148
+ }
149
149
150
150
it should " generate markdown correctly for type parameter and wildcard" in {
151
- markdown(" @apidoc[Source[ServerSentEvent, \\ _]]" ) shouldEqual
152
- html(
153
- """ <p><span class="group-java">
154
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Source.html">Source<ServerSentEvent, ?></a></span><span class="group-scala">
155
- |<a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Source.html">Source[ServerSentEvent, _]</a></span>
156
- |</p>""" .stripMargin
157
- )
158
- }
151
+ markdown(" @apidoc[Source[ServerSentEvent, \\ _]]" ) shouldEqual
152
+ html(
153
+ """ <p><span class="group-java">
154
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Source.html">Source<ServerSentEvent, ?></a></span><span class="group-scala">
155
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Source.html">Source[ServerSentEvent, _]</a></span>
156
+ |</p>""" .stripMargin
157
+ )
158
+ }
159
159
160
160
it should " generate markdown correctly for type parameters with concrete names" in {
161
- markdown(" @apidoc[Flow[Message, Message, Mat]]" ) shouldEqual
162
- html(
163
- """ <p><span class="group-java">
164
- |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow<Message, Message, Mat></a></span><span class="group-scala">
165
- |<a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Flow.html">Flow[Message, Message, Mat]</a></span>
166
- |</p>""" .stripMargin
167
- )
168
- }
161
+ markdown(" @apidoc[Flow[Message, Message, Mat]]" ) shouldEqual
162
+ html(
163
+ """ <p><span class="group-java">
164
+ |<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html">Flow<Message, Message, Mat></a></span><span class="group-scala">
165
+ |<a href="https://doc.akka.io/api/akka/2.5/akka/stream/scaladsl/Flow.html">Flow[Message, Message, Mat]</a></span>
166
+ |</p>""" .stripMargin
167
+ )
168
+ }
169
169
170
170
it should " generate markdown correctly for nested type parameters" in {
171
- markdown(" @apidoc[Marshaller[Try[A], B]]" ) shouldEqual
172
- html(
173
- """ <p><span class="group-java">
174
- |<a href="https://doc.akka.io/japi/akka-http/current/?akka/http/javadsl/marshalling/Marshaller.html">Marshaller<Try<A>, B></a></span><span class="group-scala">
175
- |<a href="https://doc.akka.io/api/akka-http/current/akka/http/scaladsl/marshalling/Marshaller.html">Marshaller[Try[A], B]</a></span>
176
- |</p>""" .stripMargin
177
- )
178
- }
171
+ markdown(" @apidoc[Marshaller[Try[A], B]]" ) shouldEqual
172
+ html(
173
+ """ <p><span class="group-java">
174
+ |<a href="https://doc.akka.io/japi/akka-http/current/?akka/http/javadsl/marshalling/Marshaller.html">Marshaller<Try<A>, B></a></span><span class="group-scala">
175
+ |<a href="https://doc.akka.io/api/akka-http/current/akka/http/scaladsl/marshalling/Marshaller.html">Marshaller[Try[A], B]</a></span>
176
+ |</p>""" .stripMargin
177
+ )
178
+ }
179
179
}
0 commit comments