[HBASE-20876] Improve docs style in HConstants

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha-1
• Labels: beginner beginners newbie
• Assignee: Wei-Chiu Chuang
• Reporter: Reid Chan
• Created: 12/Jul/18 06:21
• Updated: 21/Jul/21 14:18
• Resolved: 21/Jul/21 14:18

Description

In HConstants, there's a docs snippet:

 /** Don't use it! This'll get you the wrong path in a secure cluster.
  * Use FileSystem.getHomeDirectory() or
  * "/user/" + UserGroupInformation.getCurrentUser().getShortUserName()  */

It's ugly style.

Let's improve this docs with following

/**
 * Description
 */