Javadoc Plugin added, site description modified, link to javadoc documentation added in sidebar

70e872d4 · soaresdepaula · b30f95af · 70e872d4 · 70e872d4 · 70e872d4
Commit 70e872d4 authored Jan 01, 2020 by soaresdepaula
Hide whitespace changes
Inline Side-by-side

Showing with 36 additions and 9 deletions

pom.xml pom.xml +12 -0

src/site/markdown/index.md src/site/markdown/index.md +22 -8

src/site/site.xml src/site/site.xml +2 -1

No files found.
--- a/pom.xml
+++ b/pom.xml
@@ -179,6 +179,18 @@
                    </reportSet>
                </reportSets>
            </plugin>
+            
+            <plugin>
+        		<groupId>org.apache.maven.plugins</groupId>
+        		<artifactId>maven-javadoc-plugin</artifactId>
+        		<version>3.1.1</version>
+        		<configuration>
+        			<!--  The following path is related to javadoc's place my computer -->
+        			<javadocExecutable>/usr/bin/javadoc</javadocExecutable> <!-- Added to avoid error in BUILD of the mvn site command, related to JAVA_HOME error --> 
+          			<source>8</source> <!-- Added to avoid error in BUILD of the mvn site command, related to modules -->
+          			<show>public</show>
+        		</configuration>
+      		</plugin>
        </plugins>
    </reporting>


--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
-# Hello this is the main page of the report website
+# Calculator Project

-This file is written in _markdown_.
+**Author** Maxime Lefrançois
+ 
+**Mail** maxime.lefrancois@emse.fr

-## That's a h2
+[**Gitlab Repository**](https://gitlab.emse.fr/i2si2019/calculator) 

-* it 
-* is 
-* a 
-* great
-* project
+### Definition

+This project is aimed to students of the Interoperability Toolbox at École des Mines de Saint-Étienne [(EMSE)](https://www.mines-stetienne.fr/) during the 2019.2 semester period.
+
+
+### Subjects Explored in Project
+* Java
+* Git
+* GitLab
+* Maven
+* Docker
+* GitLab CI/CD
+
+### Task References
+- [Javadoc Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html)
+
+
+*For further information, please contact the author of this project*
\ No newline at end of file
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -16,13 +16,14 @@ See the License for the specific language governing permissions and
 <project xmlns="http://maven.apache.org/DECORATION/1.6.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/DECORATION/1.6.0 http://maven.apache.org/xsd/decoration-1.6.0.xsd">

    <bannerLeft>
-        <name>${organization.name}</name>
+        <name>École des Mines de Saint-Étienne (EMSE)</name>
        <src>logo.png</src>
    </bannerLeft>
    
    <body>
        <menu name="Overview">
            <item name="Introduction" href="index.html"/>
+            <item name="Javadoc Documentation" href="../site"/>
        </menu>
        <menu ref="reports" inherit="top"/>
    </body>