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>8.1.1</version>
  16         <relativePath/>
  17     </parent>
  18
  19     <groupId>org.opendaylight.controller</groupId>
  20     <artifactId>controller-docs</artifactId>
  21     <packaging>jar</packaging>
  22     <version>4.0.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>controller-artifacts</artifactId>
  31                 <version>${project.version}</version>
  32                 <type>pom</type>
  33                 <scope>import</scope>
  34             </dependency>
  35         </dependencies>
  36     </dependencyManagement>
  37
  38     <dependencies>
  39         <!-- Config Subsystem remnants -->
  40         <dependency>
  41             <groupId>org.opendaylight.controller</groupId>
  42             <artifactId>netty-event-executor-config</artifactId>
  43         </dependency>
  44         <dependency>
  45             <groupId>org.opendaylight.controller</groupId>
  46             <artifactId>netty-threadgroup-config</artifactId>
  47         </dependency>
  48         <dependency>
  49             <groupId>org.opendaylight.controller</groupId>
  50             <artifactId>netty-timer-config</artifactId>
  51         </dependency>
  52         <dependency>
  53             <groupId>org.opendaylight.controller</groupId>
  54             <artifactId>threadpool-config-api</artifactId>
  55         </dependency>
  56         <dependency>
  57             <groupId>org.opendaylight.controller</groupId>
  58             <artifactId>threadpool-config-impl</artifactId>
  59         </dependency>
  60
  61         <!-- Base model augmentations -->
  62         <dependency>
  63             <groupId>org.opendaylight.controller.model</groupId>
  64             <artifactId>model-inventory</artifactId>
  65         </dependency>
  66         <dependency>
  67             <groupId>org.opendaylight.controller.model</groupId>
  68             <artifactId>model-topology</artifactId>
  69         </dependency>
  70
  71         <!-- Clustered implementation -->
  72         <dependency>
  73             <groupId>org.opendaylight.controller</groupId>
  74             <artifactId>sal-clustering-commons</artifactId>
  75         </dependency>
  76         <dependency>
  77             <groupId>org.opendaylight.controller</groupId>
  78             <artifactId>sal-distributed-datastore</artifactId>
  79         </dependency>
  80         <dependency>
  81             <groupId>org.opendaylight.controller</groupId>
  82             <artifactId>sal-remoterpc-connector</artifactId>
  83         </dependency>
  84         <dependency>
  85             <groupId>org.opendaylight.controller</groupId>
  86             <artifactId>sal-akka-raft</artifactId>
  87         </dependency>
  88         <dependency>
  89             <groupId>org.opendaylight.controller</groupId>
  90             <artifactId>cds-access-api</artifactId>
  91         </dependency>
  92         <dependency>
  93             <groupId>org.opendaylight.controller</groupId>
  94             <artifactId>cds-access-client</artifactId>
  95         </dependency>
  96         <dependency>
  97             <groupId>org.opendaylight.controller</groupId>
  98             <artifactId>sal-cluster-admin-api</artifactId>
  99         </dependency>
 100         <dependency>
 101             <groupId>org.opendaylight.controller</groupId>
 102             <artifactId>sal-cluster-admin-impl</artifactId>
 103         </dependency>
 104         <dependency>
 105             <groupId>org.opendaylight.controller</groupId>
 106             <artifactId>cds-dom-api</artifactId>
 107         </dependency>
 108
 109         <!-- Third-party dependencies -->
 110         <dependency>
 111             <groupId>javax.inject</groupId>
 112             <artifactId>javax.inject</artifactId>
 113             <scope>provided</scope>
 114         </dependency>
 115         <dependency>
 116             <groupId>org.kohsuke.metainf-services</groupId>
 117             <artifactId>metainf-services</artifactId>
 118         </dependency>
 119         <dependency>
 120             <groupId>org.osgi</groupId>
 121             <artifactId>org.osgi.core</artifactId>
 122         </dependency>
 123         <dependency>
 124             <groupId>org.osgi</groupId>
 125             <artifactId>osgi.cmpn</artifactId>
 126         </dependency>
 127     </dependencies>
 128
 129     <build>
 130         <plugins>
 131             <plugin>
 132                 <artifactId>maven-dependency-plugin</artifactId>
 133                 <executions>
 134                     <execution>
 135                         <id>unpack-sources</id>
 136                         <phase>prepare-package</phase>
 137                         <goals>
 138                             <goal>unpack-dependencies</goal>
 139                         </goals>
 140                         <configuration>
 141                             <silent>true</silent>
 142                             <classifier>sources</classifier>
 143                             <includes>org/opendaylight/**</includes>
 144                             <includeGroupIds>org.opendaylight.controller</includeGroupIds>
 145                             <outputDirectory>${project.build.directory}/src</outputDirectory>
 146                         </configuration>
 147                     </execution>
 148                 </executions>
 149             </plugin>
 150
 151             <plugin>
 152                 <groupId>org.codehaus.mojo</groupId>
 153                 <artifactId>build-helper-maven-plugin</artifactId>
 154                 <executions>
 155                     <execution>
 156                         <id>add-source</id>
 157                         <!-- post-compile, but before prepare-package -->
 158                         <phase>process-classes</phase>
 159                         <goals>
 160                             <goal>add-source</goal>
 161                         </goals>
 162                         <configuration>
 163                             <sources>
 164                                 <source>${project.build.directory}/src</source>
 165                             </sources>
 166                         </configuration>
 167                     </execution>
 168                 </executions>
 169             </plugin>
 170
 171             <plugin>
 172                 <artifactId>maven-source-plugin</artifactId>
 173                 <executions>
 174                     <execution>
 175                         <id>attach-sources</id>
 176                         <!-- prepare-package so we build the source package before javadoc -->
 177                         <phase>prepare-package</phase>
 178                         <goals>
 179                             <goal>jar-no-fork</goal>
 180                         </goals>
 181                     </execution>
 182                 </executions>
 183             </plugin>
 184
 185             <plugin>
 186                 <artifactId>maven-clean-plugin</artifactId>
 187                 <executions>
 188                     <execution>
 189                         <id>remove-undocumented-sources</id>
 190                         <!-- Before javadoc runs -->
 191                         <phase>prepare-package</phase>
 192                         <goals>
 193                             <goal>clean</goal>
 194                         </goals>
 195                         <configuration>
 196                             <excludeDefaultDirectories>true</excludeDefaultDirectories>
 197                             <filesets>
 198                                 <fileset>
 199                                     <directory>${project.build.directory}/src</directory>
 200                                     <includes>
 201                                         <include>**/$YangModelBindingProvider.java</include>
 202                                         <include>**/$YangModuleInfoImpl.java</include>
 203                                     </includes>
 204                                 </fileset>
 205                             </filesets>
 206                         </configuration>
 207                     </execution>
 208                 </executions>
 209             </plugin>
 210             <plugin>
 211                 <artifactId>maven-javadoc-plugin</artifactId>
 212                 <executions>
 213                     <execution>
 214                         <id>attach-javadocs</id>
 215                         <goals>
 216                             <goal>jar</goal>
 217                         </goals>
 218                     </execution>
 219                 </executions>
 220                 <!-- FIXME: remove this section once we can activate javadoc-links profile -->
 221                 <configuration combine.children="append">
 222                     <links>
 223                         <link>https://junit.org/junit4/javadoc/4.13/</link>
 224                         <link>http://hamcrest.org/JavaHamcrest/javadoc/2.2/</link>
 225                         <link>http://google.github.io/truth/api/1.0.1/</link>
 226                         <link>http://www.slf4j.org/apidocs/</link>
 227                         <link>https://google.github.io/guava/releases/29.0-jre/api/docs/</link>
 228                         <link>http://doc.akka.io/japi/akka/2.6.12/</link>
 229                         <link>http://netty.io/4.1/api/</link>
 230                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/</link>
 231                         <link>https://commons.apache.org/proper/commons-lang/javadocs/api-3.9/</link>
 232                         <link>https://commons.apache.org/proper/commons-codec/apidocs/</link>
 233
 234                         <link>https://www.javadoc.io/doc/org.opendaylight.odlparent/odlparent-docs/8.1.1/</link>
 235                         <link>https://www.javadoc.io/doc/org.opendaylight.yangtools/yangtools-docs/6.0.5/</link>
 236                         <link>https://www.javadoc.io/doc/org.opendaylight.mdsal/mdsal-docs/7.0.6/</link>
 237                     </links>
 238                     <groups>
 239                         <group>
 240                             <title>Distributed Datastore Access API</title>
 241                             <packages>org.opendaylight.controller.cluster.access:org.opendaylight.controller.cluster.access.commands:org.opendaylight.controller.cluster.access.concepts</packages>
 242                         </group>
 243                         <group>
 244                             <title>Distributed Datastore Access Client</title>
 245                             <packages>org.opendaylight.controller.cluster.access.client</packages>
 246                         </group>
 247                         <group>
 248                             <title>Distributed Datastore DOM API extensions</title>
 249                             <packages>org.opendaylight.controller.cluster.dom.api</packages>
 250                         </group>
 251                         <group>
 252                             <title>Akka RAFT implementation</title>
 253                             <packages>org.opendaylight.controller.cluster.raft*</packages>
 254                         </group>
 255                         <group>
 256                             <title>MD-SAL Tracing Utilities</title>
 257                             <packages>org.opendaylight.controller.md.sal.trace.*:org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace.rev160908*</packages>
 258                         </group>
 259                     </groups>
 260                 </configuration>
 261             </plugin>
 262         </plugins>
 263     </build>
 264 </project>