• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Liutauras Vilda
  • Tim Cooke
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Devaka Cooray
  • Ron McLeod
  • paul wheaton
Saloon Keepers:
  • Tim Moores
  • Piet Souris
  • Tim Holloway
  • Stephan van Hulst
  • Carey Brown
Bartenders:
  • Al Hobbs
  • Frits Walraven
  • Scott Selikoff

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

 
Ranch Hand
Posts: 30
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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,
 
Ranch Hand
Posts: 296
Eclipse IDE Firefox Browser Tomcat Server
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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
 
sameer sood
Ranch Hand
Posts: 30
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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..
 
Java Cowboy
Posts: 16084
88
Android Scala IntelliJ IDE Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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?
 
Bartender
Posts: 825
5
Python Ruby Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

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.
 
sameer sood
Ranch Hand
Posts: 30
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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
Posts: 16084
88
Android Scala IntelliJ IDE Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
That's just part of the functionality of Sonar. You get that if you use Sonar.
 
Maybe he went home and went to bed. And took this tiny ad with him:
the value of filler advertising in 2021
https://coderanch.com/t/730886/filler-advertising
reply
    Bookmark Topic Watch Topic
  • New Topic