• Post Reply Bookmark Topic Watch Topic
  • New Topic

Documenting lock(-1)

 
Marcos Motta
Ranch Hand
Posts: 56
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I created the constant

that I use internaly to handle database locks, but I am not sure if I should document the use of this constant in the lock()'s javadoc instead of '-1'.
Suggestions?
thank you
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Posts: 12056
232
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Marcos
I used my constant in my JavaDoc for lock(), and didnt spell out what the constant was - if a programmer was reallyinterested in knowing the exact value then they could look it up in the JavaDoc for the constant itself.
Regards, Andrew
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!