[incubator-plc4x] branch develop updated: Cleaning up in the poms and documenting some of the settings.

[cd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git


The following commit(s) were added to refs/heads/develop by this push:
     new 73456be  Cleaning up in the poms and documenting some of the settings.
73456be is described below

commit 73456bef9758dcb709d13c36bd296f50436d223a
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Dec 27 17:53:26 2018 +0100

    Cleaning up in the poms and documenting some of the settings.
---
 plc4cpp/api/pom.xml  | 49 ++++++++++++++++++++-----------------------------
 plc4cpp/libs/pom.xml |  3 +++
 2 files changed, 23 insertions(+), 29 deletions(-)

diff --git a/plc4cpp/api/pom.xml b/plc4cpp/api/pom.xml
index 6a16ec1..85fc8d3 100644
--- a/plc4cpp/api/pom.xml
+++ b/plc4cpp/api/pom.xml
@@ -33,31 +33,15 @@
   <description>Central API Module.</description>
 
   <build>
+    <!-- This is probably not required, however it helps IntelliJ detect the files as sources -->
     <sourceDirectory>${project.basedir}/src/main/cpp</sourceDirectory>
     <plugins>
-      <!--plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>native-maven-plugin</artifactId>
-        <version>1.0-alpha-9</version>
-        <extensions>true</extensions>
-        <configuration>
-          <sources>
-            <source>
-              <directory>${project.basedir}/src/main/cpp</directory>
-              <includes>
-                <include>**/*.cpp</include>
-              </includes>
-            </source>
-          </sources>
-          <!- Tell the compiler where to find the header files ->
-          <compilerStartOptions>-I${project.basedir}/../libs/libs/boost-${boost.version}-${os.suffix}/include</compilerStartOptions>
-        </configuration>
-      </plugin-->
       <plugin>
         <groupId>com.googlecode.cmake-maven-project</groupId>
         <artifactId>cmake-maven-plugin</artifactId>
         <version>3.7.2-b1</version>
         <executions>
+          <!-- Uses a CMake generator to generate the build using the build tool of choice -->
           <execution>
             <id>cmake-generate</id>
             <phase>process-sources</phase>
@@ -65,23 +49,29 @@
               <goal>generate</goal>
             </goals>
             <configuration>
+              <!--
+                Actually the path to the CMakeList.txt file which then again
+                tells to tool where to find the sources.
+              -->
               <sourcePath>${project.basedir}/src/main/cpp</sourcePath>
+              <!--
+                Path to where the build configuration is generated
+                (This directory is then used in the compile step to actually perform the build)
+              -->
               <targetPath>${project.build.directory}/make</targetPath>
+              <!--
+                Name of the generator the compile step will be executing.
+              -->
               <generator>${cmake.generator}</generator>
-              <!-- The classifier of the current platform. One of [windows-x86_32, windows-x86_64, linux-x86_32, linux-x86_64, linux-arm_32, mac-x86_64]. -->
+              <!--
+                The classifier of the current platform. One of
+                [windows-x86_32, windows-x86_64, linux-x86_32, linux-x86_64, linux-arm_32, mac-x86_64].
+                It defines the version and type of the cmake installation to download.
+              -->
               <classifier>${os.classifier}</classifier>
-              <!--environmentVariables>
-                <key>value</key>
-              </environmentVariables-->
-              <!--options>
-                <!-
-                  Optional: One or more options found at https://cmake.org/cmake/help/v3.7/manual/cmake.1.html
-                  For example:
-                ->
-                <option>-DBUILD_THIRDPARTY:bool=on</option>
-              </options-->
             </configuration>
           </execution>
+          <!-- Actually executes the build -->
           <execution>
             <id>cmake-compile</id>
             <phase>compile</phase>
@@ -89,6 +79,7 @@
               <goal>compile</goal>
             </goals>
             <configuration>
+              <!-- The directory where the "generate" step generated the build configuration -->
               <projectDirectory>${project.build.directory}/make</projectDirectory>
               <classifier>${os.classifier}</classifier>
             </configuration>
diff --git a/plc4cpp/libs/pom.xml b/plc4cpp/libs/pom.xml
index 0dcf782..4943b63 100644
--- a/plc4cpp/libs/pom.xml
+++ b/plc4cpp/libs/pom.xml
@@ -130,8 +130,11 @@
                 <configuration>
                   <executable>${boost.build.executable}</executable>
                   <arguments>
+                    <!-- Have the build install the built libraries -->
                     <argument>install</argument>
+                    <!-- Tell it where to install the libraries and header files -->
                     <argument>--prefix=${project.basedir}/libs/boost</argument>
+                    <!-- On Windows machines the build failed, if this was not explicitly set -->
                     <argument>address-model=64</argument>
                   </arguments>
                   <workingDirectory>${project.build.directory}/libs/boost_${boost.version.underline}</workingDirectory>