Results 1 to 6 of 6
Like Tree2Likes
  • 1 Post By Tolls
  • 1 Post By Tolls

Thread: javadocs

  1. #1
    noobplus's Avatar
    noobplus is offline Senior Member
    Join Date
    Feb 2012
    Location
    chennai,south of India(south east of asia)
    Posts
    232
    Rep Power
    3

    Question javadocs

    Hi,
    I'm creating javadocs for my project work (so as to increase number of pages of my project documentation. my codings are only 15 pages long )

    /**
    * @author <b>Dhilipkumar</b>
    *
    * @category ??
    * @deprecated ??
    * @serial ??
    * @version ??
    * @see ??
    * @since ??
    */


    What are they used for? thanks
    --Edited to add: anyother javadoc commands can be added to increase codings size?

    regards
    dhilip
    Last edited by noobplus; 03-26-2012 at 11:02 AM.

  2. #2
    noobplus's Avatar
    noobplus is offline Senior Member
    Join Date
    Feb 2012
    Location
    chennai,south of India(south east of asia)
    Posts
    232
    Rep Power
    3

    Default Re: javadocs

    Hi again,
    when I add "@deprecated" to my class javadoc in eclipse, the class name becomes slashed with a line over its name.
    javadocs-underpressure.jpg

    thanks
    dhilip

  3. #3
    Tolls is offline Moderator
    Join Date
    Apr 2009
    Posts
    12,014
    Rep Power
    20

    Default Re: javadocs

    That's because 'deprecated' flags it as a method or class or attribute you should not be using and may, in a future release, be removed entirely.
    The docs would also usually say what you should be using instead of the deprecated thing.
    noobplus likes this.
    Please do not ask for code as refusal often offends.

    ** This space for rent **

  4. #4
    noobplus's Avatar
    noobplus is offline Senior Member
    Join Date
    Feb 2012
    Location
    chennai,south of India(south east of asia)
    Posts
    232
    Rep Power
    3

    Default Re: javadocs

    Quote Originally Posted by Tolls View Post
    That's because 'deprecated' flags it as a method or class or attribute you should not be using and may, in a future release, be removed entirely.
    The docs would also usually say what you should be using instead of the deprecated thing.
    thank you,
    and what means @category
    also this one, {@code}
    if I knew about these two, I can elongate my code

    thanks
    dhilip

  5. #5
    Tolls is offline Moderator
    Join Date
    Apr 2009
    Posts
    12,014
    Rep Power
    20

    Default Re: javadocs

    You could simply look this up you know.
    Javadoc doc tags.
    noobplus likes this.
    Please do not ask for code as refusal often offends.

    ** This space for rent **

  6. #6
    noobplus's Avatar
    noobplus is offline Senior Member
    Join Date
    Feb 2012
    Location
    chennai,south of India(south east of asia)
    Posts
    232
    Rep Power
    3

    Default Re: javadocs

    Quote Originally Posted by Tolls View Post
    You could simply look this up you know.
    Javadoc doc tags.
    actually thank you very much, I was looking for that site on web, and didn't get it
    I was searching "javadoc docs" lol

    regards
    dhilip

Similar Threads

  1. Adding Javadocs Without IDE's
    By Black_Sirrah239 in forum New To Java
    Replies: 1
    Last Post: 11-28-2011, 09:43 PM
  2. setting up javadocs?
    By PersonUsingEclipse in forum Eclipse
    Replies: 0
    Last Post: 01-29-2009, 03:42 AM
  3. Lost my javadocs
    By orchid in forum Eclipse
    Replies: 3
    Last Post: 04-30-2008, 09:45 PM
  4. JavaDocs
    By Asguarde in forum New To Java
    Replies: 4
    Last Post: 03-15-2008, 04:13 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •