Add controller aggregate javadocs
[controller.git] / docs / pom.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- vi: set et smarttab sw=4 tabstop=4: -->
3 <!--
4  Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
5
6  This program and the accompanying materials are made available under the
7  terms of the Eclipse Public License v1.0 which accompanies this distribution,
8  and is available at http://www.eclipse.org/legal/epl-v10.html
9 -->
10 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
11     <modelVersion>4.0.0</modelVersion>
12     <parent>
13         <groupId>org.opendaylight.odlparent</groupId>
14         <artifactId>odlparent</artifactId>
15         <version>4.0.9</version>
16         <relativePath/>
17     </parent>
18
19     <groupId>org.opendaylight.controller</groupId>
20     <artifactId>controller-docs</artifactId>
21     <packaging>jar</packaging>
22     <version>0.10.0-SNAPSHOT</version>
23     <name>${project.artifactId}</name>
24     <description>Controller documentation</description>
25
26     <dependencyManagement>
27         <dependencies>
28             <dependency>
29                 <groupId>org.opendaylight.controller</groupId>
30                 <artifactId>config-artifacts</artifactId>
31                 <version>0.11.0-SNAPSHOT</version>
32                 <type>pom</type>
33                 <scope>import</scope>
34             </dependency>
35             <dependency>
36                 <groupId>org.opendaylight.controller</groupId>
37                 <artifactId>mdsal-artifacts</artifactId>
38                 <version>1.10.0-SNAPSHOT</version>
39                 <type>pom</type>
40                 <scope>import</scope>
41             </dependency>
42         </dependencies>
43     </dependencyManagement>
44
45     <dependencies>
46         <!-- Config Subsystem remnants -->
47         <dependency>
48             <groupId>org.opendaylight.controller</groupId>
49             <artifactId>netty-config-api</artifactId>
50         </dependency>
51         <dependency>
52             <groupId>org.opendaylight.controller</groupId>
53             <artifactId>netty-event-executor-config</artifactId>
54         </dependency>
55         <dependency>
56             <groupId>org.opendaylight.controller</groupId>
57             <artifactId>netty-threadgroup-config</artifactId>
58         </dependency>
59         <dependency>
60             <groupId>org.opendaylight.controller</groupId>
61             <artifactId>netty-timer-config</artifactId>
62         </dependency>
63         <dependency>
64             <groupId>org.opendaylight.controller</groupId>
65             <artifactId>threadpool-config-api</artifactId>
66         </dependency>
67         <dependency>
68             <groupId>org.opendaylight.controller</groupId>
69             <artifactId>threadpool-config-impl</artifactId>
70         </dependency>
71
72         <!-- MD-SAL artifacts -->
73         <dependency>
74             <groupId>org.opendaylight.controller</groupId>
75             <artifactId>sal-common-api</artifactId>
76         </dependency>
77         <dependency>
78             <groupId>org.opendaylight.controller</groupId>
79             <artifactId>sal-common-impl</artifactId>
80         </dependency>
81         <dependency>
82             <groupId>org.opendaylight.controller</groupId>
83             <artifactId>sal-common-util</artifactId>
84         </dependency>
85         <dependency>
86             <groupId>org.opendaylight.controller</groupId>
87             <artifactId>sal-core-api</artifactId>
88         </dependency>
89         <dependency>
90             <groupId>org.opendaylight.controller</groupId>
91             <artifactId>sal-core-spi</artifactId>
92         </dependency>
93         <dependency>
94             <groupId>org.opendaylight.controller</groupId>
95             <artifactId>sal-core-compat</artifactId>
96         </dependency>
97         <dependency>
98             <groupId>org.opendaylight.controller</groupId>
99             <artifactId>sal-broker-impl</artifactId>
100         </dependency>
101         <dependency>
102             <groupId>org.opendaylight.controller</groupId>
103             <artifactId>sal-binding-api</artifactId>
104         </dependency>
105         <dependency>
106             <groupId>org.opendaylight.controller</groupId>
107             <artifactId>sal-binding-broker-impl</artifactId>
108         </dependency>
109         <dependency>
110             <groupId>org.opendaylight.controller</groupId>
111             <artifactId>sal-binding-util</artifactId>
112         </dependency>
113         <dependency>
114             <groupId>org.opendaylight.controller</groupId>
115             <artifactId>sal-connector-api</artifactId>
116         </dependency>
117         <dependency>
118             <groupId>org.opendaylight.controller</groupId>
119             <artifactId>sal-inmemory-datastore</artifactId>
120         </dependency>
121         <dependency>
122             <groupId>org.opendaylight.controller</groupId>
123             <artifactId>mdsal-trace-api</artifactId>
124         </dependency>
125         <dependency>
126             <groupId>org.opendaylight.controller</groupId>
127             <artifactId>mdsal-trace-dom-impl</artifactId>
128         </dependency>
129         <dependency>
130             <groupId>org.opendaylight.controller</groupId>
131             <artifactId>mdsal-trace-binding-impl</artifactId>
132         </dependency>
133
134         <!-- Base model augmentations -->
135         <dependency>
136             <groupId>org.opendaylight.controller.model</groupId>
137             <artifactId>model-inventory</artifactId>
138         </dependency>
139         <dependency>
140             <groupId>org.opendaylight.controller.model</groupId>
141             <artifactId>model-topology</artifactId>
142         </dependency>
143
144         <!-- Clustered implementation -->
145         <dependency>
146             <groupId>org.opendaylight.controller</groupId>
147             <artifactId>sal-clustering-commons</artifactId>
148         </dependency>
149         <dependency>
150             <groupId>org.opendaylight.controller</groupId>
151             <artifactId>sal-clustering-config</artifactId>
152         </dependency>
153         <dependency>
154             <groupId>org.opendaylight.controller</groupId>
155             <artifactId>sal-distributed-datastore</artifactId>
156         </dependency>
157         <dependency>
158             <groupId>org.opendaylight.controller</groupId>
159             <artifactId>sal-remoterpc-connector</artifactId>
160         </dependency>
161         <dependency>
162             <groupId>org.opendaylight.controller</groupId>
163             <artifactId>sal-akka-raft</artifactId>
164         </dependency>
165         <dependency>
166             <groupId>org.opendaylight.controller</groupId>
167             <artifactId>cds-access-api</artifactId>
168         </dependency>
169         <dependency>
170             <groupId>org.opendaylight.controller</groupId>
171             <artifactId>cds-access-client</artifactId>
172         </dependency>
173         <dependency>
174             <groupId>org.opendaylight.controller</groupId>
175             <artifactId>sal-cluster-admin-api</artifactId>
176         </dependency>
177         <dependency>
178             <groupId>org.opendaylight.controller</groupId>
179             <artifactId>sal-cluster-admin-impl</artifactId>
180         </dependency>
181         <dependency>
182             <groupId>org.opendaylight.controller</groupId>
183             <artifactId>cds-dom-api</artifactId>
184         </dependency>
185
186         <!-- MessageBus -->
187         <dependency>
188             <groupId>org.opendaylight.controller</groupId>
189             <artifactId>messagebus-api</artifactId>
190         </dependency>
191         <dependency>
192             <groupId>org.opendaylight.controller</groupId>
193             <artifactId>messagebus-spi</artifactId>
194         </dependency>
195         <dependency>
196             <groupId>org.opendaylight.controller</groupId>
197             <artifactId>messagebus-impl</artifactId>
198         </dependency>
199         <dependency>
200             <groupId>org.opendaylight.controller</groupId>
201             <artifactId>messagebus-util</artifactId>
202         </dependency>
203     </dependencies>
204
205     <build>
206         <plugins>
207             <plugin>
208                 <artifactId>maven-dependency-plugin</artifactId>
209                 <executions>
210                     <execution>
211                         <id>unpack-sources</id>
212                         <phase>prepare-package</phase>
213                         <goals>
214                             <goal>unpack-dependencies</goal>
215                         </goals>
216                         <configuration>
217                             <silent>true</silent>
218                             <classifier>sources</classifier>
219                             <includes>org/opendaylight/**</includes>
220                             <includeGroupIds>org.opendaylight.controller</includeGroupIds>
221                             <outputDirectory>${project.build.directory}/src</outputDirectory>
222                         </configuration>
223                     </execution>
224                 </executions>
225             </plugin>
226
227             <plugin>
228                 <groupId>org.codehaus.mojo</groupId>
229                 <artifactId>build-helper-maven-plugin</artifactId>
230                 <executions>
231                     <execution>
232                         <id>add-source</id>
233                         <!-- post-compile, but before prepare-package -->
234                         <phase>process-classes</phase>
235                         <goals>
236                             <goal>add-source</goal>
237                         </goals>
238                         <configuration>
239                             <sources>
240                                 <source>${project.build.directory}/src</source>
241                             </sources>
242                         </configuration>
243                     </execution>
244                 </executions>
245             </plugin>
246
247             <plugin>
248                 <artifactId>maven-source-plugin</artifactId>
249                 <executions>
250                     <execution>
251                         <id>attach-sources</id>
252                         <!-- prepare-package so we build the source package before javadoc -->
253                         <phase>prepare-package</phase>
254                         <goals>
255                             <goal>jar-no-fork</goal>
256                         </goals>
257                     </execution>
258                 </executions>
259             </plugin>
260
261             <plugin>
262                 <artifactId>maven-clean-plugin</artifactId>
263                 <executions>
264                     <execution>
265                         <id>remove-undocumented-sources</id>
266                         <!-- Before javadoc runs -->
267                         <phase>prepare-package</phase>
268                         <goals>
269                             <goal>clean</goal>
270                         </goals>
271                         <configuration>
272                             <excludeDefaultDirectories>true</excludeDefaultDirectories>
273                             <filesets>
274                                 <fileset>
275                                     <directory>${project.build.directory}/src</directory>
276                                     <includes>
277                                         <include>**/$YangModelBindingProvider.java</include>
278                                         <include>**/$YangModuleInfoImpl.java</include>
279                                     </includes>
280                                 </fileset>
281                             </filesets>
282                         </configuration>
283                     </execution>
284                 </executions>
285             </plugin>
286             <plugin>
287                 <artifactId>maven-javadoc-plugin</artifactId>
288                     <!-- FIXME: remove override once odlparent ships 3.1.0+ -->
289                 <version>3.0.0</version>
290                 <executions>
291                     <execution>
292                         <id>attach-javadocs</id>
293                         <goals>
294                             <goal>jar</goal>
295                         </goals>
296                     </execution>
297                 </executions>
298                 <!-- FIXME: remove this section once we can activate javadoc-links profile -->
299                 <configuration combine.children="append">
300                     <links>
301                         <link>https://junit.org/junit4/javadoc/4.11/</link>
302                         <link>http://hamcrest.org/JavaHamcrest/javadoc/1.3/</link>
303                         <link>http://google.github.io/truth/api/0.42/</link>
304                         <link>https://www.slf4j.org/apidocs/</link>
305                         <link>https://xerces.apache.org/xerces2-j/javadocs/api/</link>
306                         <link>https://google.github.io/guava/releases/25.1-jre/api/docs/</link>
307                         <link>http://doc.akka.io/japi/akka/2.5.19/</link>
308                         <link>http://netty.io/4.1/api/</link>
309                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/</link>
310                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-3.8.1/</link>
311                         <link>https://commons.apache.org/proper/commons-codec/apidocs/</link>
312                     </links>
313                     <groups>
314                         <group>
315                             <title>Distributed Datastore Access API</title>
316                             <packages>org.opendaylight.controller.cluster.access:org.opendaylight.controller.cluster.access.commands:org.opendaylight.controller.cluster.access.concepts</packages>
317                         </group>
318                         <group>
319                             <title>Distributed Datastore Access Client</title>
320                             <packages>org.opendaylight.controller.cluster.access.client</packages>
321                         </group>
322                         <group>
323                             <title>Distributed Datastore DOM API extensions</title>
324                             <packages>org.opendaylight.controller.cluster.dom.api</packages>
325                         </group>
326                         <group>
327                             <title>MD-SAL Common API (deprecated)</title>
328                             <packages>org.opendaylight.controller.md.sal.common.*</packages>
329                         </group>
330                         <group>
331                             <title>MD-SAL Low-level (DOM) API (deprecated)</title>
332                             <packages>org.opendaylight.controller.md.sal.dom.api:org.opendaylight.controller.md.sal.dom.spi:org.opendaylight.controller.sal.core.*</packages>
333                         </group>
334                         <group>
335                             <title>MD-SAL Binding API (deprecated)</title>
336                             <packages>org.opendaylight.controller.sal.binding.api*:org.opendaylight.controller.md.sal.binding.api*:org.opendaylight.controller.md.sal.binding.spi:org.opendaylight.controller.md.sal.binding.compat:org.opendaylight.controller.md.sal.binding.util</packages>
337                         </group>
338                         <group>
339                             <title>Akka RAFT implementation</title>
340                             <packages>org.opendaylight.controller.cluster.raft*</packages>
341                         </group>
342                         <group>
343                             <title>MD-SAL Message Bus Bridge (experimental)</title>
344                             <packages>org.opendaylight.controller.messagebus.*:org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.*</packages>
345                         </group>
346                         <group>
347                             <title>MD-SAL Tracing Utilities</title>
348                             <packages>org.opendaylight.controller.md.sal.trace.*:org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace.rev160908*</packages>
349                         </group>
350                     </groups>
351                 </configuration>
352             </plugin>
353         </plugins>
354     </build>
355 </project>

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.