Use Javadoc for API documentation

[marschall]

Java offers two kinds of multi line comments /** and /*.
The first is called Javadoc and ends up in generated API documentation
and is displayed by IDEs. The second is a multi line comment that does
not show up.

There are several places there /* instead of /** is used for API
documentation.

[1] https://stackoverflow.com/questions/29815636/and-in-java-comments
[2] http://javadude.com/articles/comments.html

[codecov-io]

Codecov Report

Merging #305 into dev will increase coverage by 0.13%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##                dev     #305      +/-   ##
============================================
+ Coverage     37.23%   37.36%   +0.13%     
- Complexity     1663     1671       +8     
============================================
  Files           103      103              
  Lines         23673    23673              
  Branches       3882     3882              
============================================
+ Hits           8814     8846      +32     
+ Misses        13261    13232      -29     
+ Partials       1598     1595       -3

Flag	Coverage Δ	Complexity Δ
#JDBC41	37.19% <ø> (+0.1%)	1659 <ø> (+2)	⬆️
#JDBC42	37.14% <ø> (+0.05%)	1663 <ø> (+7)	⬆️

Impacted Files	Coverage Δ	Complexity Δ
src/main/java/microsoft/sql/Types.java	0% <ø> (ø)	0 <0> (ø)	⬇️
...m/microsoft/sqlserver/jdbc/SQLServerStatement.java	59.08% <ø> (ø)	129 <0> (ø)	⬇️
...dbc/SQLServerStatementColumnEncryptionSetting.java	100% <ø> (ø)	1 <0> (ø)	⬇️
...c/main/java/com/microsoft/sqlserver/jdbc/Util.java	45.15% <0%> (-0.71%)	60% <0%> (-1%)
...rc/main/java/com/microsoft/sqlserver/jdbc/DDC.java	30.13% <0%> (-0.23%)	57% <0%> (+1%)
...oft/sqlserver/jdbc/SQLServerPreparedStatement.java	33.62% <0%> (+0.17%)	90% <0%> (+1%)	⬆️
...in/java/com/microsoft/sqlserver/jdbc/IOBuffer.java	46.69% <0%> (+0.4%)	0% <0%> (ø)	⬇️
...m/microsoft/sqlserver/jdbc/SQLServerResultSet.java	27.61% <0%> (+0.58%)	190% <0%> (+5%)	⬆️
...om/microsoft/sqlserver/jdbc/ReaderInputStream.java	46.06% <0%> (+4.49%)	17% <0%> (+3%)	⬆️
...ava/com/microsoft/sqlserver/jdbc/ScrollWindow.java	73.17% <0%> (+4.87%)	17% <0%> (+1%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f4b87c3...a9c70cc. Read the comment docs.

[msftclas]

@marschall, thanks for signing the contribution license agreement. We will now validate the agreement and then the pull request.

Thanks, Microsoft Pull Request Bot

[marschall]

As an example have a look at:
https://static.javadoc.io/com.microsoft.sqlserver/mssql-jdbc/6.1.7.jre8-preview/microsoft/sql/Types.html