Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Apache Maven Cookbook
  • Table Of Contents Toc
  • Feedback & Rating feedback
Apache Maven Cookbook

Apache Maven Cookbook

By : Raghuram Bharathan
4.2 (5)
Buy this Book
close
close
Apache Maven Cookbook

Apache Maven Cookbook

4.2 (5)
By: Raghuram Bharathan
Buy this Book

Overview of this book

If you are a Java developer or a manager who has experience with Apache Maven and want to extend your knowledge, then this is the ideal book for you. Apache Maven Cookbook is for those who want to learn how Apache Maven can be used for build automation. It is also meant for those familiar with Apache Maven, but want to understand the finer nuances of Maven and solve specific problems.
Table of Contents (13 chapters)
close
close
close
Preface
Icon
Preface
Icon
What this book covers
Icon
What you need for this book
Icon
Who this book is for
Icon
Sections
Icon
Conventions
Icon
Reader feedback
Icon
Customer support
Free Chapter
1
1. Getting Started
Icon
1. Getting Started
Icon
Introduction
Icon
Installing Maven on Microsoft Windows
Icon
Installing Maven on Mac OS X
Icon
Installing Maven on Linux
Icon
Changing the JDK used by Maven
Icon
Creating a simple project with Maven
Icon
Building a simple project with Maven
Icon
Changing the location of the Maven repository
Icon
Running Maven behind an HTTP proxy server
Icon
Understanding the standard directory layout
2
2. IDE Integration with Maven
Icon
2. IDE Integration with Maven
Icon
Introduction
Icon
Creating a new Maven project in Eclipse
Icon
Importing an existing Maven project in Eclipse
Icon
Creating a new Maven project in NetBeans
Icon
Importing an existing Maven project in NetBeans
Icon
Creating a new Maven project in IntelliJ IDEA
Icon
Importing an existing Maven project in IntelliJ IDEA
3
3. Maven Lifecycle
Icon
3. Maven Lifecycle
Icon
Introduction
Icon
Understanding the Maven lifecycle, phases, and goals
Icon
Understanding the pom file
Icon
Understanding Maven settings
Icon
Understanding command-line options in Maven
Icon
Understanding Maven profiles
Icon
Adding a new Maven profile
Icon
Activating/deactivating a Maven profile
Icon
Using properties in Maven
Icon
Specifying source encoding for platform-independent builds
4
4. Essential Maven Plugins
Icon
4. Essential Maven Plugins
Icon
Introduction
Icon
Using the Maven Clean plugin
Icon
Using the Maven Compiler plugin
Icon
Changing the compiler used by the Maven Compiler plugin
Icon
Specifying the Java version for the Compiler plugin
Icon
Using the Maven Surefire plugin to run unit tests
Icon
Using the Maven Failsafe plugin to run integration tests
Icon
Using the Maven Resources plugin
Icon
Filtering using resources
Icon
Using Eclipse to run Maven goals
Icon
Using NetBeans to run Maven goals
Icon
Using IntelliJ IDEA to run Maven goals
5
5. Dependency Management
Icon
5. Dependency Management
Icon
Introduction
Icon
Choosing the scope of dependency
Icon
Getting a report of dependencies
Icon
Getting into dependency and avoiding dependency hell
Icon
Downloading dependencies into a folder
Icon
Understanding SNAPSHOT dependencies
Icon
Handling dependency download errors
Icon
Detecting unused/undeclared dependencies
Icon
Manually installing dependencies that are not available in a repository
Icon
Dependency management using Eclipse
Icon
Dependency management using NetBeans
Icon
Dependency management using IntelliJ IDEA
6
6. Code Quality Plugins
Icon
6. Code Quality Plugins
Icon
Introduction
Icon
Analyzing code coverage with the Maven JaCoCo plugin
Icon
Analyzing code coverage with the Maven Cobertura plugin
Icon
Analyzing code with the Maven PMD plugin
Icon
Analyzing code with the Maven Checkstyle plugin
Icon
Analyzing code with the Maven FindBugs plugin
Icon
Generating source references with the Maven JXR plugin
Icon
Analyzing code with the Maven SonarQube plugin
7
7. Reporting and Documentation
chevron up
Icon
7. Reporting and Documentation
Icon
Introduction
Icon
Documenting with the Maven Site plugin
Icon
Generating Javadocs for a site
Icon
Generating source cross-reference for a site
Icon
Generating unit test reports for a site
Icon
Generating code coverage reports for a site
Icon
Generating code quality reports for a site
Icon
Generating selective reports
Icon
Deploying a site
8
8. Handling Typical Build Requirements
Icon
8. Handling Typical Build Requirements
Icon
Introduction
Icon
Including and excluding additional resources
Icon
Including and excluding source files and folders
Icon
Configuring Maven to search for plugins
Icon
Working in offline mode
Icon
Controlling the verbosity of the Maven output
Icon
Using the Maven Help plugin
Icon
Using the Maven SCM plugin
Icon
Generating changelogs for a site
9
9. Multi-module Projects
Icon
9. Multi-module Projects
Icon
Introduction
Icon
Understanding project inheritance
Icon
Understanding project aggregation
Icon
Combining inheritance and aggregation
Icon
Performing multi-module dependency management
Icon
Performing multi-module plugin management
Icon
Selectively building modules
Icon
Reporting for multi-module projects
10
10. Java Development with Maven
Icon
10. Java Development with Maven
Icon
Introduction
Icon
Building a JAR project
Icon
Generating an executable JAR
Icon
Generating a JAR of the source code
Icon
Generating a JAR of the test classes
Icon
Building a WAR project
Icon
Building an EAR project
Icon
Building a pom project
Icon
Running a web project with Jetty
Icon
Running a web project with Tomcat
11
11. Advanced Maven Usage
Icon
11. Advanced Maven Usage
Icon
Introduction
Icon
Creating an assembly
Icon
Running a custom executable
Icon
Running an ANT task
Icon
Determining updates to Maven plugin AntRun
Icon
Determining updates to Maven dependencies
Icon
Controlling the constraints
Icon
Generating unique builds
Icon
Releasing a Maven project
12
Index
Icon
Index

Generating Javadocs for a site

Documentation for Java projects is created using Javadocs. Maven provides support not only to generate Javadocs, but also to publish them as part of the site. Plugins configured within the reporting element will generate content for the site. When they are configured within the build element, they can generate reports independent of site.

How to do it...

Use the following steps to generate Javadocs for a site:

  1. Open the Maven project project-with-documentation.

  2. Add the following section in the pom.xml file:

    <reporting>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.10.1</version>
    </plugin>
  </plugins>
</reporting>

  3. Run the following command:

    mvn site

  4. See the report generated:

  5. Click on the JavaDocs link:

How it works...

We added the Javadoc plugin to the reporting section of pom. When the Site plugin...

Unlock full access

Continue reading for free

A Packt free trial gives you instant online access to our library of over 7000 practical eBooks and videos, constantly updated with the latest in tech
Start a 7-day FREE trial
End of Section 5
Next Section

Create a Note

Modal Close icon
You need to login to use this feature.
notes
bookmark search playlist download
font-size

Change the font size

margin-width

Change margin width

day-mode

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Delete Bookmark

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Delete Note

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Edit Note

Modal Close icon
Write a note (max 255 characters)
Cancel
Update Note

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY