This week's book giveaway is in the Clojure forum.
We're giving away four copies of Clojure in Action and have Amit Rathore and Francis Avila on-line!
See this thread for details.
Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Do we need to build directory structure in source directory?

 
Holmes Wong
Ranch Hand
Posts: 163
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have a source directory which contains all source files, I am wondering if we need to
build a directory structure following that of
object files? If we have three packages in source
directory, then, it seems it will be really hard to use javadoc to create doc files. Any comments?
 
John Smith
Ranch Hand
Posts: 2937
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

... it seems it will be really hard to use javadoc to create doc files

Not hard at all. Just specify path to source and path to classes, and javadoc utility will find your source. For example:

Eugene.
 
Mark Spritzler
ranger
Sheriff
Posts: 17276
6
IntelliJ IDE Mac Spring
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Well I just had the .class files and .java files in the same directories.
I didn't seperate the source from the compiled class. Then my javadoc command was a simple line.
javadoc -private suncertify.db suncertify.client suncertify.help
Now in real life it is more maintainable to seperate the source from compiled.
Mark
 
Holmes Wong
Ranch Hand
Posts: 163
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks, guys.
Mark, why do we need to expose our private
members? I only showed public and protected
members.
 
Mark Spritzler
ranger
Sheriff
Posts: 17276
6
IntelliJ IDE Mac Spring
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I just liked to show private too. I like that they show the private in Java's API docs, so I just followed that. I don't think it really matters.
Mark
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic