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