aspose file tools*
The moose likes Java in General and the fly likes How can I convert my java project to a wiki or make it browsable Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Java » Java in General
Bookmark "How can I convert my java project to a wiki or make it browsable" Watch "How can I convert my java project to a wiki or make it browsable" New topic
Author

How can I convert my java project to a wiki or make it browsable

sameer sood
Ranch Hand

Joined: Dec 05, 2007
Posts: 30
Hi.

I want to convert my java project into something like they way java documentation is.

Where we can have package level boxes in front and then we can go into each package and read their documentation.

Is there any open source out of the box tool for the same ?

Thanks,


Sameer Sood
SCJP 1.5 (93%), SCWCD 1.5 (95%)
Sumit Patil
Ranch Hand

Joined: May 25, 2009
Posts: 296

Java 2 SDK comes with Javadoc, it is a tool for generating API documentation in HTML format from doc comments in source code.
Javadoc Home Page


Thanks & Regards, Sumeet
SCJP 1.4, SCWCD 5, LinkedIn Profile
sameer sood
Ranch Hand

Joined: Dec 05, 2007
Posts: 30
I am aware of javadoc

Something like here in section below

http://nemo.sonarsource.org/dashboard/index/176188


I am looking for open source not a paid one..
Jesper de Jong
Java Cowboy
Saloon Keeper

Joined: Aug 16, 2005
Posts: 14268
    
  21

You don't need to pay for javadoc, it's a standard tool in the JDK.

I'm confused. First you ask for a tool and it looks like what you're looking for is javadoc, but then you point to a Sonar page, which is something completely different. Sonar is also open source and you don't need to pay for it.

So what is it exactly that you're looking for?


Java Beginners FAQ - JavaRanch SCJP FAQ - The Java Tutorial - Java SE 8 API documentation
Kemal Sokolovic
Bartender

Joined: Jun 19, 2010
Posts: 825
    
    5

sameer sood wrote:
Where we can have package level boxes in front and then we can go into each package and read their documentation.

That's javadoc, and you can generate it from javadoc comments of your code using almost any IDE you use for development.

sameer sood wrote:
"How can I convert my java project to a wiki or make it browsable"

The question makes no sense.

If you want to have keep wiki for your projects, try browsing for some version control systems that provide it.


The quieter you are, the more you are able to hear.
sameer sood
Ranch Hand

Joined: Dec 05, 2007
Posts: 30
There was a link visible below this post. I thought someone posted it, was a link to some paid tool.

Now it is showing it as an advertisement.

On Sonar page i wanted to show you the way code is arranged in bottom left corner, you click each package and reach into it, box in box in approach in html.
Jesper de Jong
Java Cowboy
Saloon Keeper

Joined: Aug 16, 2005
Posts: 14268
    
  21

That's just part of the functionality of Sonar. You get that if you use Sonar.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: How can I convert my java project to a wiki or make it browsable