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