Welcome to the Java Programming Forums


The professional, friendly Java community. 21,500 members and growing!


The Java Programming Forums are a community of Java programmers from all around the World. Our members have a wide range of skills and they all have one thing in common: A passion to learn and code Java. We invite beginner Java programmers right through to Java professionals to post here and share your knowledge. Become a part of the community, help others, expand your knowledge of Java and enjoy talking with like minded people. Registration is quick and best of all free. We look forward to meeting you.


>> REGISTER NOW TO START POSTING


Members have full access to the forums. Advertisements are removed for registered users.

Results 1 to 3 of 3

Thread: Javadoc link to external resource

  1. #1
    Forum VIP
    Join Date
    Jul 2010
    Posts
    1,630
    Thanks
    25
    Thanked 322 Times in 300 Posts

    Default Javadoc link to external resource

    So I just have a theory question here and I'm looking for a brainstorming session.
    In our product, we have many different of "roles". Some of these roles are defined in our dataload JSON and others are defined in our bootstrap SQL.
    Throughout our code, we refer to specific roles by name. We want to provide some sort of documentation for these roles when we mention them in documentation, but we don't want to maintain multiple definitions/descriptions for these roles (ie: we don't want one for documentation and a separate one for execution).
    Can anyone think of a way we can "expose" the role definitions to the documentation? The best thing I've got is adding some sort of "export script" to each generation of the javadocs, but I don't have a clue how, or if, that can even be done...
    NOTE TO NEW PEOPLE LOOKING FOR HELP ON FORUM:

    When asking for help, please follow these guidelines to receive better and more prompt help:
    1. Put your code in Java Tags. To do this, put [highlight=java] before your code and [/highlight] after your code.
    2. Give full details of errors and provide us with as much information about the situation as possible.
    3. Give us an example of what the output should look like when done correctly.

    Join the Airline Management Simulation Game to manage your own airline against other users in a virtual recreation of the United States Airline Industry. For more details, visit: http://airlinegame.orgfree.com/


  2. #2
    Crazy Cat Lady KevinWorkman's Avatar
    Join Date
    Oct 2010
    Location
    Washington, DC
    Posts
    5,301
    My Mood
    Hungover
    Thanks
    142
    Thanked 620 Times in 531 Posts

    Default Re: Javadoc link to external resource

    In your code, you should probably be referring to variables defined somewhere, not hard-coded constants. All you really need to do is javadoc these variables.

    See the SwingConstants interface for an example of what I'm talking about.
    Useful links: How to Ask Questions the Smart Way | Use Code Tags | Java Tutorials
    Static Void Games - Play indie games, learn from game tutorials and source code, upload your own games!

  3. #3
    Forum VIP
    Join Date
    Jul 2010
    Posts
    1,630
    Thanks
    25
    Thanked 322 Times in 300 Posts

    Default Re: Javadoc link to external resource

    The role variables are defined in the dataload JSON and the bootstrap SQL, which is where the descriptions for the variables are. I'm not 100% sure on the exact way they are imported at runtime.
    The problem is that when the API is generated, the descriptions for the roles are not provided in any way, since the source of the roles is a resource instead of code. Ideally, we'd like to pull those descriptions out somehow for the documentation.
    NOTE TO NEW PEOPLE LOOKING FOR HELP ON FORUM:

    When asking for help, please follow these guidelines to receive better and more prompt help:
    1. Put your code in Java Tags. To do this, put [highlight=java] before your code and [/highlight] after your code.
    2. Give full details of errors and provide us with as much information about the situation as possible.
    3. Give us an example of what the output should look like when done correctly.

    Join the Airline Management Simulation Game to manage your own airline against other users in a virtual recreation of the United States Airline Industry. For more details, visit: http://airlinegame.orgfree.com/

Similar Threads

  1. javadoc creation
    By e93 in forum What's Wrong With My Code?
    Replies: 2
    Last Post: January 15th, 2014, 05:46 AM
  2. javadoc does'nt work
    By demirel77 in forum Java IDEs
    Replies: 1
    Last Post: December 13th, 2013, 04:44 AM
  3. Javadoc questions
    By bdennin in forum What's Wrong With My Code?
    Replies: 4
    Last Post: January 31st, 2013, 07:10 PM
  4. Creating a javadoc help please.
    By jerryg in forum What's Wrong With My Code?
    Replies: 6
    Last Post: March 8th, 2012, 09:10 AM
  5. How do you generate javadoc?
    By javapenguin in forum Java IDEs
    Replies: 15
    Last Post: November 27th, 2010, 08:12 PM