Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc related questions

 
Andy Jung
Ranch Hand
Posts: 150
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,

the submission demands to javadoc all public members of a class.
What about implemented methods or overridden ones? Do they have to be documented as well,
even if they are already in the interface or base class respectively?
What does the official sun recommendations say to this?

Kind regards,
Andy
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Andy,

I just used for implemented and/or overridden methods.

Kind regards,
Roel
 
Andy Jung
Ranch Hand
Posts: 150
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Roel,

thanks for that hint, I didn't know that this tag would exist.
Besides this, the NetBeans-IDE autocompletes an Overridden-Annotation for overridden methods:



How to place an "at"-Symbol in this forum anyway, doesn't work ?
Andy
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Andy,

I use Eclipse as IDE (which has the overridden annotation too )

How to place an "at"-Symbol in this forum anyway, doesn't work ?

I guess some symbols and some abbreviations are not allowed to be posted (I edited your post and added the @ without any problem, but maybe that's thanks to my super powers as being a bartender, I honestly don't know)

Kind regards,
Roel
 
Carlos Morillo
Ranch Hand
Posts: 221
Java Python Scala
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Roel De Nijs wrote:Hi Andy,

I just used for implemented and/or overridden methods.

Kind regards,
Roel


I think the annotation



accomplishes the same.


Best,


Carlos.
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Carlos,

I even have:above each implemented/overridden method

Kind regards,
Roel
 
Andy Jung
Ranch Hand
Posts: 150
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Roel,

I'm not sure if the (at)Overridden-annotation is eligible also for implemented methods?
My IDE (NetBeans) only suggests this for overridden methods not for implemented ones

Kind regards,
Andy
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Andy,

I used them for both and if you use JDK 1.5 you'll get compiler errors on interface implementations From JDK6 and JDK7

the (at)Overridden-annotation
Is this some special NetBeans annotation? If it is, I would use the annotation @Override from the Java API.

Kind regards,
Roel
 
Andy Jung
Ranch Hand
Posts: 150
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Roel,

sorry, of course I meant @Override, I was not concentrated when writing this.

Where's the job left converting the @-symbol ?

Kind regards,
Andy

[edit] job done
 
Carlos Morillo
Ranch Hand
Posts: 221
Java Python Scala
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Andy Jung wrote:
sorry, of course I meant (at)Override, I was not concentrated when writing this.


Please be concentrated next time when you post something since you need to be considerate
with the time other ranchers take out of their spare time to answer questions.

Best,

Carlos.
 
Bob Carr
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have a very similar problem with javadoc. But it seems to be adhoc as far as I can see. Is there something I am missing?

As an example:
I have a class extending the AbstractTableModel.
So in my class I implement all the parent's methods...e.g. I have the following.


However, when I generate the java doc for this class, the @Override only works for the setValueAt method however for the getValueAt, it does not show any inherit information


Does anyone know why this @Override is generating correct javadoc for setValueAt method only?
 
Bob Carr
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Further about my issue... I found out the following. If I modified my code


It will actually pickup the @Override in the javadoc generated for the getValueAt() {..}.
It seems to be that if the method is not mentioned in the AbstractTableModel and only in the TableModel, then javadoc will not create this inheritance information in the javadoc.

Any ideas on how to overcome this?
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic