Add a desciption and comments to the pom.xml

Nathanael Jourdane
1 parent 32746123
Showing 1 changed file with 32 additions and 27 deletions Show diff stats
pom.xml
 <?xml version="1.0" encoding="UTF-8"?>
 <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">
+	
+	<!-- Basic informations -->
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>eu.omp.irap.vespa</groupId>
 	<artifactId>epntapclient</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 	<name>epnTAPCLient</name>
+	<description>The Epn-TAP library aims to provide methods to manage resources, services and dataset wich implements the epn-TAP core, in order to get data and deal with it with any other software, ie. though a SAMP hub. It also comes with a GUI, initialy built to be integrated on the Cassis sofware, but it can be launch as standalone.</description>
+	<url>http://cassis.irap.omp.eu/</url>
+	
+	<!-- The developers of the library. -->
 	<developers>
 		<developer>
 			<name>Nathanaël Jourdane</name>
@@ -16,12 +22,15 @@
 			</roles>
 		</developer>
 	</developers>
+	
+	<!-- The files encoding. -->
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 	</properties>
 	<build>
 		<plugins>
+		
 			<!-- Tell to Maven wich Java version is used. -->
 			<plugin>
 				<artifactId>maven-compiler-plugin</artifactId>
@@ -31,6 +40,7 @@
 					<target>1.7</target>
 				</configuration>
 			</plugin>
+			
 			<!-- Sign the jar in order to push it to cassis repository. -->
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
@@ -57,6 +67,7 @@
 					<verbose>true</verbose>
 				</configuration>
 			</plugin>
+			
 			<!-- Generate model classes (voTable and voResource) from xsd schemas -->
 			<plugin>
 				<groupId>org.jvnet.jaxb2.maven2</groupId>
@@ -72,28 +83,20 @@
 						<configuration>
 							<schemaDirectory>src/main/resources/xsd</schemaDirectory>
 							<bindingDirectory>src/main/resources/xjb</bindingDirectory>
+							<!-- The xjb file tels to xjc which xsd file is associated to some Java package. -->
+							<!-- It also modify voTable.xsd in order to rename the `Value`, which is a xjc keyword. -->
 						</configuration>
 					</execution>
 				</executions>
 			</plugin>
-			<!-- Ant plugin to add suppress-warnings in generated code. -->
 			<plugin>
+			
+				<!-- Ant executions. -->
 				<artifactId>maven-antrun-plugin</artifactId>
 				<version>1.7</version>
 				<executions>
 					<execution>
-						<id>remove-episode</id>
-						<phase>process-sources</phase>
-						<goals>
-							<goal>run</goal>
-						</goals>
-						<configuration>
-							<target name="Removing META-INF/sun-jaxb.episode">
-								<delete file="${basedir}/src/main/java/META-INF/sun-jaxb.episode" />
-							</target>
-						</configuration>
-					</execution>
-					<execution>
+						<!-- Add @SuppressWarnings annotations for each class of the generated code. -->
 						<id>suppress-warning-generated</id>
 						<phase>process-sources</phase>
 						<goals>
@@ -119,8 +122,8 @@
 				</executions>
 			</plugin>
 		</plugins>
-		<!-- To avoid Eclipse warnings "Plugin execution not covered by lifecycle 
-			configuration" -->
+		
+		<!-- Avoid Eclipse warnings "Plugin execution not covered by lifecycle configuration" -->
 		<pluginManagement>
 			<plugins>
 				<plugin>
@@ -132,15 +135,9 @@
 							<pluginExecutions>
 								<pluginExecution>
 									<pluginExecutionFilter>
-										<groupId>
-											org.apache.maven.plugins
-										</groupId>
-										<artifactId>
-											maven-antrun-plugin
-										</artifactId>
-										<versionRange>
-											[1.7,)
-										</versionRange>
+										<groupId> org.apache.maven.plugins </groupId>
+										<artifactId> maven-antrun-plugin </artifactId>
+										<versionRange> [1.7,) </versionRange>
 										<goals>
 											<goal>run</goal>
 										</goals>
@@ -156,22 +153,26 @@
 			</plugins>
 		</pluginManagement>
 	</build>
+	
+	<!-- The project dependencies -->
 	<dependencies>
 		<dependency>
+		
+			<!-- A library to deal with JSON files -->
 			<groupId>com.google.code.gson</groupId>
 			<artifactId>gson</artifactId>
 			<version>2.2.2</version>
 			<scope>compile</scope>
 		</dependency>
 	</dependencies>
+	
 	<profiles>
+		<!-- This profile is activated by the "-P jenkins" switch when run on the build server by 
+		Jenkins (continuous integration) -->
 		<profile>
 			<id>jenkins</id>
-			<!-- This profile is activated by the "-P jenkins" switch when run on 
-				the build server by Jenkins (continuous integration) -->
 			<build>
 				<plugins>
-					<!-- Jenkins should only build -SNAPSHOTs -->
 					<plugin>
 						<artifactId>maven-enforcer-plugin</artifactId>
 						<executions>
@@ -182,6 +183,7 @@
 								<configuration>
 									<rules>
 										<evaluateBeanshell>
+											<!-- Jenkins should only build -SNAPSHOTs -->
 											<condition>"${project.version}".endsWith("-SNAPSHOT")</condition>
 											<message>Jenkins should only build -SNAPSHOT versions</message>
 										</evaluateBeanshell>
@@ -195,12 +197,15 @@
 			</build>
 		</profile>
 	</profiles>
+	
+	<!-- The repository where to deploy the project. -->
 	<repositories>
 		<repository>
 			<id>IRAP-NEXUS</id>
 			<url>https://nexus.irap.omp.eu/content/groups/public</url>
 		</repository>
 	</repositories>
+	
 	<!-- For using it, (with mvn deploy) it need the <server(s)> config on ~/m2/settings.xml 
 		with the logins for nexus. -->
 	<distributionManagement>