• Menu
  • Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar

JavaBeat

Java Tutorial Blog

  • Java
    • Java 7
    • Java 8
    • Java EE
    • Servlets
  • Spring Framework
    • Spring Tutorials
    • Spring 4 Tutorials
    • Spring Boot
  • JSF Tutorials
  • Most Popular
    • Binary Search Tree Traversal
    • Spring Batch Tutorial
    • AngularJS + Spring MVC
    • Spring Data JPA Tutorial
    • Packaging and Deploying Node.js
  • About Us
    • Join Us (JBC)
  • Java
    • Java 7
    • Java 8
    • Java EE
    • Servlets
  • Spring Framework
    • Spring Tutorials
    • Spring 4 Tutorials
    • Spring Boot
  • JSF Tutorials
  • Most Popular
    • Binary Search Tree Traversal
    • Spring Batch Tutorial
    • AngularJS + Spring MVC
    • Spring Data JPA Tutorial
    • Packaging and Deploying Node.js
  • About Us
    • Join Us (JBC)

How To Generate Javadoc With Ant

December 27, 2013 //  by Krishna Srinivasan//  Leave a Comment

This tutorial explains how to create Java documentation using the ant script. Every project has Java doc for the documentation purpose. If you have huge application, there should be a clear Java doc for the developers to aware of all the classes and its purposes. If the developers add good comments on their code, Java doc will be very useful for the future reference. In the common scenario, this Java doc has to generated while building the project. If we have ant configured to generate this for you, it is good. Lets see an example ant script which will help you to generate the Java doc. There are many other parameters can be passed to this task, you read more details here.

ant

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project basedir="." default="javadocs" name="Java Doc">
	<property environment="env" />
	<property name="target" value="1.6" />
	<property name="source" value="1.6" />
	<property name="src.dir" value="${basedir}/src" />
	<property name="target.dir" value="${basedir}/target" />
	<property name="src.lib" location="${basedir}" />
	<path id="classpath">
		<fileset dir="${src.lib}">
			<include name="*.jar" />
		</fileset>
	</path>
	<target name="javadocs" description="Generate JavaDoc API docs">
		<delete dir="${target.dir}/docs" failonerror="false" />
		<mkdir dir="${target.dir}/docs" />
		<javadoc destdir="${target.dir}/docs" classpathref="classpath" packagenames="*.*"
			author="false" private="true" version="true" windowtitle="Simple Documentation">
			<packageset dir="${src.dir}" />
		</javadoc>
	</target>
</project>

Category: Apache AntTag: Apache Ant, JavaDoc

About Krishna Srinivasan

He is Founder and Chief Editor of JavaBeat. He has more than 8+ years of experience on developing Web applications. He writes about Spring, DOJO, JSF, Hibernate and many other emerging technologies in this blog.

Previous Post: « JPA 2 MetaModel Generator using Ant
Next Post: JPA EntityManagerFactory Vs Hibernate’s SessionFactory »

Reader Interactions

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Primary Sidebar

Follow Us

  • Facebook
  • Pinterest

FEATURED TUTORIALS

New Features in Spring Boot 1.4

Difference Between @RequestParam and @PathVariable in Spring MVC

What is new in Java 6.0 Collections API?

The Java 6.0 Compiler API

Introductiion to Jakarta Struts

What’s new in Struts 2.0? – Struts 2.0 Framework

JavaBeat

Copyright © by JavaBeat · All rights reserved
Privacy Policy | Contact