This week's book giveaway is in the HTML/CSS/JavaScript forum.
We're giving away four copies of Practical SVG and have Chris Coyier on-line!
See this thread for details.
Win a copy of Practical SVG this week in the HTML/CSS/JavaScript forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

Re: Javadoc

 
Joe Cheung
Ranch Hand
Posts: 104
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Dear all,
I want to use javadoc to generate html files for my project. But, I don't know how to add class description in my java source files such that a description text like below can ne generated:
public class Base64InputStream
extends java.io.FilterInputStream
a utility class which wraps around any given inputstream and decodes the inputstream as per the BASE64 encoding standards.
This class reads data from the underlying inputstream in chunks of four.
How should I comment my java source files to schieve the above result.
Regards,
Joe
 
Ernest Friedman-Hill
author and iconoclast
Sheriff
Posts: 24213
35
Chrome Eclipse IDE Mac OS X
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Like this:
 
Bear Bibeault
Author and ninkuma
Marshal
Posts: 65535
108
IntelliJ IDE Java jQuery Mac Mac OS X
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!