Reference Guide

public DocProvider() {
super("hm", "rsdoc", DocProvider.class.getClassLoader());
}
}
NOTE
The name used to call the super class constructor (“hm”
in DocProvider.java listing) must not contain
spaces; it may be any name but with no spaces because it is used to generate internal paths.
RSdoc Provider Dependency:
<dependency>
<groupId>com.hp.sdn</groupId>
<artifactId>sdn-adm-api</artifactId>
<version>${sdn.version}</version>
</dependency>
Modify hm-rs/pom.xml file to include the plug-in in charge of executing the command used to
generate the RSdoc as shown in the following RSdoc Generation Maven Configuration llisting. This
plugin executes a tool offered by the HP VAN SDN Controller SDK that generates the RSdoc
based on the parameters used in RSdoc Generation Maven Configuration listing.
RSdoc Generation Maven Configuration:
...
<properties>
<banned.rs.paths>com.hp.hm.rs</banned.rs.paths>
<webapp.context>sdn/hm/v1.0</webapp.context>
<web.context.path>sdn/hm/v1.0</web.context.path>
<!-- RSdoc properties -->
<api.name>Device Health Monitor v1.0</api.name>
<api.version>1.0</api.version>
<api.url>https://localhost:8443/${webapp.context}</api.url>
</properties>
...
<build>
<plugins>
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<id>generate-resources</id>
<phase>process-resources</phase>
<configuration>
<tasks>
<delete dir="target/classes/rsdoc" />
<mkdir dir="target/classes/rsdoc" />
194