Working with Java and XML documentation

One of the ways to create documentation for your java code is to use the 'javadoc' tool that comes along with your java SDK installation. Otherwise you can use documentation tools available from a third party like AurigaDoc.

_______________________________________________


_______________________________________________



This tool is java-XML-XSL based. With this tool you can convert your documentation into other formats like PDF, DHTML, FO, RTF, Java Help, and HTML Help. This tool keeps a single source and uses XSL to convert the XML document into other format using XSLT.

You can customize the transformation by using your own customized XSL file. There is an option to configure which XSL to use for the transformation. You can call this AurigaDoc tool from within your java classes or invoke it in command line.

Using the javadoc tool is very simple you have to write your documentation comments above the class or a field or constructor in a certain format. You have to start your comments with "/**" and then finish it with "*/". That's it. then you have to run the javadoc tool to generate the documentation.

Current Newswire: (Linux Today)
"Microsoft is apparently serious about its efforts to adhere to the letter of the Open Source Definition and is now set to relaunch its Sandcastle effort as a result.

Altova UModel Adds Support for the Business Process Modeling Notation (BPMN) in Version 2008 Release 2 (Marketwire via Yahoo! Finance)
Altova®, creator of XMLSpy®, the industry leading XML editor, and other popular XML, data management, UML, and Web services tools, recently announced the availability of Altova UModel Version 2008 Release 2.

Job vacancy: Senior Development Officer (PublicTechnology.net)
(Ref: SDO) The successful candidate will join our Business & Information Systems Development team and work in an open plan office with the rest of the team. The post-holder will assist the development team in all aspects of its work.

Movie download device runs embedded Linux framework (Linux Devices)
— Jun. 16, 2008 — Trolltech announced that its graphical framework for Linux device development was used by Roku in the on-demand movie streaming device it recently built for NetFlix.



FREE Subscription

Subscribe to our mailing list and receive new articles
through email. Keep yourself updated with latest
developments in the industry.

Name:
Email:

Note : We never rent, trade, or sell my email lists to
anyone. We assure that your privacy is respected
and protected.

_______________________________________

Recommended XML Books

cover
cover
cover
cover
cover
cover





 

 

FREE Subscription

Stay Current With the Latest Technology Developments Realted to XML. Signup for Our Newsletter and Receive New Articles Through Email.

Name:

Email:

Note : We never rent, trade, or sell our email lists to anyone. We assure that your privacy is respected and protected.

 

 

Add to My Yahoo!


New XML Books Titles - Best Seller's @ Amazon.com

Visit XML Training Material Guide Homepage

Technology helps engage students - how do classroom instruction and social dynamics change when the classroom is completely dependant on modern technology?

Dallas Web Design- local Dallas web design firm offers site design and backend system development