blob: 4b2a935e0d9541aa03006a465cdb99e030032e8b [file] [log] [blame]
Thomas Vachuskac3226e92018-07-25 12:00:57 -07001load("//tools/build/bazel:project_javadoc.bzl", "project_javadoc")
Ray Milkeydd5a7bf2018-07-26 13:06:33 -07002load("//tools/build/bazel:generate_workspace.bzl", "CORE_DEPS", "ONOS_VERSION")
Thomas Vachuskac3226e92018-07-25 12:00:57 -07003
4SOURCES = glob(["src/main/javadoc/doc-files/*"]) + [
5 "src/main/javadoc/overview.html",
6 "//utils/osgi:onlab-osgi-sources",
7 "//utils/junit:onlab-junit-sources",
8 "//utils/misc:onlab-misc-sources",
9 "//utils/rest:onlab-rest-sources",
10 "//core/api:onos-api-sources",
11 "//incubator/api:onos-incubator-api-sources",
12 "//core/net:onos-core-net-sources",
13 "//core/common:onos-core-common-sources",
14 "//core/store/primitives:onos-core-primitives-sources",
15 "//core/store/serializers:onos-core-serializers-sources",
16 "//core/store/dist:onos-core-dist-sources",
17 "//core/security:onos-security-sources",
18 "//core/store/persistence:onos-core-persistence-sources",
19 "//incubator/net:onos-incubator-net-sources",
20 "//incubator/store:onos-incubator-store-sources",
21 "//incubator/rpc:onos-incubator-rpc-sources",
22 "//cli:onos-cli-sources",
23 "//web/api:onos-rest",
Thomas Vachuskac3226e92018-07-25 12:00:57 -070024 "//apps/cpman/api:onos-apps-cpman-api-sources",
25 "//apps/routing-api:onos-apps-routing-api-sources",
26 "//apps/dhcp/api:onos-apps-dhcp-api-sources",
27]
28
29INTERNAL_SOURCES = [
30 "//protocols/rest/api:onos-protocols-rest-api-sources",
31 "//protocols/rest/ctl:onos-protocols-rest-ctl-sources",
32 "//protocols/bgp/bgpio:onos-protocols-bgp-bgpio-sources",
33 "//protocols/bgp/api:onos-protocols-bgp-api-sources",
34 "//protocols/bgp/ctl:onos-protocols-bgp-ctl-sources",
35 "//protocols/netconf/api:onos-protocols-netconf-api-sources",
36 "//protocols/netconf/ctl:onos-protocols-netconf-ctl-sources",
37 "//protocols/openflow/api:onos-protocols-openflow-api-sources",
38 "//protocols/openflow/ctl:onos-protocols-openflow-ctl-sources",
39 "//protocols/ospf/api:onos-protocols-ospf-api-sources",
40 "//protocols/ospf/protocol:onos-protocols-ospf-protocol-sources",
41 "//protocols/ospf/ctl:onos-protocols-ospf-ctl-sources",
42 "//protocols/ovsdb/rfc:onos-protocols-ovsdb-rfc-sources",
43 "//protocols/ovsdb/api:onos-protocols-ovsdb-api-sources",
44 "//protocols/ovsdb/ctl:onos-protocols-ovsdb-ctl-sources",
Ray Milkeydd5a7bf2018-07-26 13:06:33 -070045 # "//protocols/p4runtime/api:onos-protocols-p4runtime-api-sources",
46 # "//protocols/p4runtime/model:onos-protocols-p4runtime-model-sources",
Thomas Vachuskac3226e92018-07-25 12:00:57 -070047 "//protocols/pcep/pcepio:onos-protocols-pcep-pcepio-sources",
48 "//protocols/pcep/server/api:onos-protocols-pcep-server-api-sources",
49 "//protocols/pcep/server/ctl:onos-protocols-pcep-server-ctl-sources",
50 "//protocols/snmp/api:onos-protocols-snmp-api-sources",
51 "//protocols/snmp/ctl:onos-protocols-snmp-ctl-sources",
52 "//protocols/isis/api:onos-protocols-isis-api-sources",
53 "//protocols/isis/ctl:onos-protocols-isis-ctl-sources",
54 "//protocols/isis/isisio:onos-protocols-isis-isisio-sources",
55 "//protocols/lisp/api:onos-protocols-lisp-api-sources",
56 "//protocols/lisp/ctl:onos-protocols-lisp-ctl-sources",
57 "//protocols/lisp/msg:onos-protocols-lisp-msg-sources",
58 "//protocols/tl1/api:onos-protocols-tl1-api-sources",
59 "//protocols/tl1/ctl:onos-protocols-tl1-ctl-sources",
60 "//protocols/restconf/client/api:onos-protocols-restconf-client-api-sources",
61 "//protocols/restconf/client/ctl:onos-protocols-restconf-client-ctl-sources",
62 "//protocols/xmpp/core/api:onos-protocols-xmpp-core-api-sources",
63 "//protocols/xmpp/core/ctl:onos-protocols-xmpp-core-ctl-sources",
Thomas Vachuskac3226e92018-07-25 12:00:57 -070064 "//drivers/utilities:onos-drivers-utilities-sources",
Thomas Vachuskac3226e92018-07-25 12:00:57 -070065 "//providers/netconf/device:onos-providers-netconf-device-sources",
66 "//providers/openflow/device:onos-providers-openflow-device-sources",
67 "//providers/openflow/packet:onos-providers-openflow-packet-sources",
68 "//providers/openflow/flow:onos-providers-openflow-flow-sources",
69 "//providers/openflow/group:onos-providers-openflow-group-sources",
70 "//providers/openflow/meter:onos-providers-openflow-meter-sources",
71 "//providers/ovsdb/device:onos-providers-ovsdb-device-sources",
72 "//providers/ovsdb/tunnel:onos-providers-ovsdb-tunnel-sources",
73 "//providers/rest/device:onos-providers-rest-device-sources",
74 "//providers/snmp/device:onos-providers-snmp-device-sources",
75 "//providers/isis/cfg:onos-providers-isis-cfg-sources",
76 "//providers/isis/topology:onos-providers-isis-topology-sources",
77 "//providers/lisp/device:onos-providers-lisp-device-sources",
78 "//providers/tl1/device:onos-providers-tl1-device-sources",
79 "//providers/general/device:onos-providers-general-device-sources",
Ray Milkeydd5a7bf2018-07-26 13:06:33 -070080 # "//providers/p4runtime/packet:onos-providers-p4runtime-packet-sources",
Thomas Vachuskac3226e92018-07-25 12:00:57 -070081 "//apps/pcep-api:onos-apps-pcep-api-sources",
82 "//apps/optical-model:onos-apps-optical-model-sources",
83 "//apps/mappingmanagement/api:onos-apps-mappingmanagement-api-sources",
84]
85
86JAVADOC_DEPS = CORE_DEPS + KRYO + REST + CLI + JACKSON + TEST + NETTY + METRICS + ONOS_YANG + [
87 "@netty//jar",
88 "@netty_codec//jar",
89 "@netty_transport//jar",
90 "@netty_handler//jar",
91 "@netty_transport_native_epoll//jar",
92 "@atomix//jar",
93 "@commons_math3//jar",
94 "@joda_time//jar",
95 "@mapdb//jar",
96 "@httpclient_osgi//jar",
97 "@httpcore_osgi//jar",
98 "@bndlib//jar",
99 "@jersey_client//jar",
100 "@jersey_server//jar",
101 "@jersey_security//jar",
102 "@org_apache_felix_scr_bnd//jar",
103 "@openflowj//jar",
104 "@org_apache_servicemix_bundles_snmp4j//jar",
105 "@snmp_core//jar",
106 "@mibs_net_snmp//jar",
107 "@mibs_rfc//jar",
108 "@tinder_xmpp//jar",
109 "@aalto_xml//jar",
110 "@stax2_api//jar",
111 "@bcprov_jdk15on//jar",
112 "@bcpkix_jdk15on//jar",
113 "@sshd_core//jar",
114 "@ganymed_ssh2//jar",
115 "@concurrent_trees//jar",
116]
117
118EXTERNAL_GROUPS = {
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700119 "Network Model & Services": ["org.onosproject.*"],
120 "Incubator for Network Model & Services": ["org.onosproject.incubator.*"],
121 "Utilities": ["org.onlab.*"],
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700122 "App & Extensions": [
123 "org.onosproject.dhcp",
124 "org.onosproject.cpman",
125 "org.onosproject.routing",
126 ],
127}
128
129INTERNAL_GROUPS = {
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700130 "Network Model & Services": ["org.onosproject.*"],
131 "Incubator for Network Model & Services": ["org.onosproject.incubator.*"],
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700132 "Core Subsystems": [
133 "org.onosproject.cfg.impl",
134 "org.onosproject.cluster.impl",
135 "org.onosproject.core.impl",
136 "org.onosproject.event.impl",
137 "org.onosproject.net.config.impl",
138 "org.onosproject.net.device.impl",
139 "org.onosproject.net.driver.impl",
140 "org.onosproject.net.edgeservice.impl",
141 "org.onosproject.net.flow.impl",
142 "org.onosproject.net.flowobjective.impl",
143 "org.onosproject.net.flowobjective.impl.composition",
144 "org.onosproject.net.group.impl",
145 "org.onosproject.net.host.impl",
146 "org.onosproject.net.intent.impl",
147 "org.onosproject.net.intent.impl.compiler",
148 "org.onosproject.net.intent.impl.phase",
149 "org.onosproject.net.intf.impl",
150 "org.onosproject.net.link.impl",
151 "org.onosproject.net.newresource.impl",
152 "org.onosproject.net.packet.impl",
153 "org.onosproject.net.proxyarp.impl",
154 "org.onosproject.net.resource.impl",
155 "org.onosproject.net.statistic.impl",
156 "org.onosproject.net.topology.impl",
157 "org.onosproject.json",
158 "org.onosproject.json.*",
159 "org.onosproject.common.*",
160 "org.onosproject.security.impl",
161 "org.onosproject.security.store",
162 ],
163 "Distributed Stores": [
164 "org.onosproject.store.*",
165 "org.onosproject.persistence.impl",
166 ],
167 "Incubator for Core Subsystems & Distributed Stores": [
168 "org.onosproject.incubator.net.impl",
169 "org.onosproject.incubator.store.impl",
170 "org.onosproject.incubator.net.resource.label.impl",
171 "org.onosproject.incubator.store.resource.impl",
172 "org.onosproject.incubator.net.tunnel.impl",
173 "org.onosproject.incubator.store.tunnel.impl",
174 "org.onosproject.incubator.net.config.impl",
175 "org.onosproject.incubator.net.domain.impl",
176 "org.onosproject.incubator.store.config.impl",
177 "org.onosproject.incubator.net.meter.impl",
178 "org.onosproject.incubator.net.resource.label",
179 "org.onosproject.incubator.store.meter.impl",
180 ],
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700181 "Utilities": ["org.onlab.*"],
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700182 "GUI, REST & Command-Line": [
183 "org.onosproject.ui.impl*",
184 "org.onosproject.rest.*",
185 "org.onosproject.cli*",
186 "org.onosproject.codec.impl",
187 ],
188 "Builtin Applications": [
189 "org.onosproject.app.*",
190 "org.onosproject.acl*",
191 "org.onosproject.aaa",
192 "org.onosproject.fwd",
193 "org.onosproject.dhcp*",
194 "org.onosproject.flowanalyzer",
195 "org.onosproject.cpman*",
196 "org.onosproject.mobility",
197 "org.onosproject.proxyarp",
198 "org.onosproject.calendar",
199 "org.onosproject.olt*",
200 "org.onosproject.optical*",
201 "org.onosproject.newoptical*",
202 "org.onosproject.sdnip",
203 "org.onosproject.sdnip.*",
204 "org.onosproject.config",
205 "org.onosproject.routing",
206 "org.onosproject.routing*",
207 "org.onosproject.bgprouter",
208 "org.onosproject.segmentrouting*",
209 "org.onosproject.reactive.routing*",
210 "org.onosproject.messagingperf",
211 "org.onosproject.virtualbng*",
212 "org.onosproject.cordfabric*",
213 "org.onosproject.xosintegration*",
214 "org.onosproject.cip*",
215 "org.onosproject.vtn*",
216 "org.onosproject.cord*",
217 "org.onosproject.mcast*",
218 "org.onosproject.mfwd*",
219 "org.onosproject.mlb*",
220 "org.onosproject.igmp*",
221 "org.onosproject.pim*",
222 "org.onosproject.vpls*",
223 "org.onosproject.vrouter*",
224 "org.onosproject.faultmanagement*",
225 "org.onosproject.iptopology*",
226 "org.onosproject.drivermatrix*",
227 "org.onosproject.pathpainter*",
228 "org.onosproject.openstack*",
229 "org.onosproject.scalablegateway*",
230 "org.onosproject.forwarder*",
231 "org.onosproject.sfc*",
232 "org.onosproject.netcfgmonitor*",
233 "org.onosproject.flowperf",
234 "org.onosproject.loadtest",
235 "org.onosproject.events",
236 "org.onosproject.bmv2*",
237 "org.onosproject.xosclient*",
238 "org.onosproject.kafkaintegration*",
239 "org.onosproject.gangliametrics*",
240 "org.onosproject.graphitemetrics*",
241 "org.onosproject.influxdbmetrics*",
242 "org.onosproject.yms*",
243 ],
244 "Test Instrumentation & Applications": [
245 "org.onosproject.metrics.*",
246 "org.onosproject.demo*",
247 "org.onosproject.election*",
248 "org.onosproject.distributedprimitives*",
249 "org.onosproject.intentperf*",
250 "org.onosproject.messagingperf*",
251 "org.onosproject.optical.testapp*",
252 ],
253 "OpenFlow Providers & Controller": [
254 "org.onosproject.openflow.*",
255 "org.onosproject.provider.of.*",
256 ],
257 "NetConf Protocol & Providers": [
258 "org.onosproject.netconf*",
259 "org.onosproject.provider.netconf*",
260 ],
261 "OVSDB Protocol & Providers": [
262 "org.onosproject.provider.ovsdb*",
263 "org.onosproject.ovsdb*",
264 ],
265 "PCEP Protocol & Providers": [
266 "org.onosproject.pce.*",
267 "org.onosproject.pcerest*",
268 "org.onosproject.pceweb*",
269 "org.onosproject.pcep*",
270 "org.onosproject.pcepio*",
271 "org.onosproject.provider.pcep*",
272 ],
273 "BGP-LS Protocol & Providers": [
274 "org.onosproject.bgp.controller*",
275 "org.onosproject.bgp*",
276 "org.onosproject.provider.bgp*",
277 ],
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700278 "OSPF Protocol & Providers": ["org.onosproject.ospf*"],
279 "ISIS Protocol & Providers": ["org.onosproject.isis*"],
280 "LISP Protocol & Providers": ["org.onosproject.lisp*"],
281 "SNMP Protocol & Providers": ["org.onosproject.snmp*"],
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700282 "REST Protocol & Providers": [
283 "org.onosproject.protocol.rest*",
284 "org.onosproject.provider.rest*",
285 ],
286 "Other Providers": [
287 "org.onosproject.provider.*",
288 "org.onosproject.protocol.*",
289 ],
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700290 "Device Drivers": ["org.onosproject.driver*"],
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700291}
292
293project_javadoc(
294 name = "external",
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700295 srcs = SOURCES,
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700296 groups = EXTERNAL_GROUPS,
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700297 title = "ONOS Java API (%s)" % ONOS_VERSION,
298 deps = JAVADOC_DEPS,
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700299)
300
301project_javadoc(
Ray Milkeydd5a7bf2018-07-26 13:06:33 -0700302 name = "internal",
303 srcs = SOURCES + INTERNAL_SOURCES,
304 groups = INTERNAL_GROUPS,
305 internal = True,
306 title = "ONOS Java API (%s)" % ONOS_VERSION,
307 deps = JAVADOC_DEPS,
Thomas Vachuskac3226e92018-07-25 12:00:57 -0700308)