Quantcast

RFR 8175846: Provide javadoc descriptions for jdk.policytool and jdk.crypto.* modules

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

RFR 8175846: Provide javadoc descriptions for jdk.policytool and jdk.crypto.* modules

Weijun Wang
Please review the patch below. I don't know if all those jdk.crypto.*
modules will be listed in the doc, but it's nice to include a comment.

Thanks
Max

diff --git a/src/jdk.policytool/share/classes/module-info.java
b/src/jdk.policytool/share/classes/module-info.java
--- a/src/jdk.policytool/share/classes/module-info.java
+++ b/src/jdk.policytool/share/classes/module-info.java
@@ -23,6 +23,14 @@
   * questions.
   */

+/**
+ * GUI tool for managing policy files.
+ *
+ * @since 9
+ * @deprecated The policytool tool has been deprecated and
+ * is planned to be removed in a future release.
+ */
+@Deprecated
  module jdk.policytool {
      requires java.desktop;
      requires java.logging;

diff --git a/src/jdk.crypto.cryptoki/share/classes/module-info.java
b/src/jdk.crypto.cryptoki/share/classes/module-info.java
--- a/src/jdk.crypto.cryptoki/share/classes/module-info.java
+++ b/src/jdk.crypto.cryptoki/share/classes/module-info.java
@@ -23,6 +23,11 @@
   * questions.
   */

+/**
+ * The SunPKCS11 security provider.
+ *
+ * @since 9
+ */
  module jdk.crypto.cryptoki {
      // Depends on SunEC provider for EC related functionality
      requires jdk.crypto.ec;
diff --git a/src/jdk.crypto.ec/share/classes/module-info.java
b/src/jdk.crypto.ec/share/classes/module-info.java
--- a/src/jdk.crypto.ec/share/classes/module-info.java
+++ b/src/jdk.crypto.ec/share/classes/module-info.java
@@ -23,6 +23,11 @@
   * questions.
   */

+/**
+ * The SunEC security provider.
+ *
+ * @since 9
+ */
  module jdk.crypto.ec {
      provides java.security.Provider with sun.security.ec.SunEC;
  }
diff --git a/src/jdk.crypto.mscapi/windows/classes/module-info.java
b/src/jdk.crypto.mscapi/windows/classes/module-info.java
--- a/src/jdk.crypto.mscapi/windows/classes/module-info.java
+++ b/src/jdk.crypto.mscapi/windows/classes/module-info.java
@@ -23,6 +23,11 @@
   * questions.
   */

+/**
+ * The SunMSCAPI security provider.
+ *
+ * @since 9
+ */
  module jdk.crypto.mscapi {
      provides java.security.Provider with sun.security.mscapi.SunMSCAPI;
  }
diff --git a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
--- a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
+++ b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
@@ -23,6 +23,11 @@
   * questions.
   */

+/**
+ * The OracleUCrypto security provider.
+ *
+ * @since 9
+ */
  module jdk.crypto.ucrypto {
      provides java.security.Provider with
com.oracle.security.ucrypto.UcryptoProvider;
  }

Thanks
Max
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR 8175846: Provide javadoc descriptions for jdk.policytool and jdk.crypto.* modules

Weijun Wang
Ping again.

On 03/01/2017 09:02 AM, Weijun Wang wrote:

> Please review the patch below. I don't know if all those jdk.crypto.*
> modules will be listed in the doc, but it's nice to include a comment.
>
> Thanks
> Max
>
> diff --git a/src/jdk.policytool/share/classes/module-info.java
> b/src/jdk.policytool/share/classes/module-info.java
> --- a/src/jdk.policytool/share/classes/module-info.java
> +++ b/src/jdk.policytool/share/classes/module-info.java
> @@ -23,6 +23,14 @@
>   * questions.
>   */
>
> +/**
> + * GUI tool for managing policy files.
> + *
> + * @since 9
> + * @deprecated The policytool tool has been deprecated and
> + * is planned to be removed in a future release.
> + */
> +@Deprecated
>  module jdk.policytool {
>      requires java.desktop;
>      requires java.logging;
>
> diff --git a/src/jdk.crypto.cryptoki/share/classes/module-info.java
> b/src/jdk.crypto.cryptoki/share/classes/module-info.java
> --- a/src/jdk.crypto.cryptoki/share/classes/module-info.java
> +++ b/src/jdk.crypto.cryptoki/share/classes/module-info.java
> @@ -23,6 +23,11 @@
>   * questions.
>   */
>
> +/**
> + * The SunPKCS11 security provider.
> + *
> + * @since 9
> + */
>  module jdk.crypto.cryptoki {
>      // Depends on SunEC provider for EC related functionality
>      requires jdk.crypto.ec;
> diff --git a/src/jdk.crypto.ec/share/classes/module-info.java
> b/src/jdk.crypto.ec/share/classes/module-info.java
> --- a/src/jdk.crypto.ec/share/classes/module-info.java
> +++ b/src/jdk.crypto.ec/share/classes/module-info.java
> @@ -23,6 +23,11 @@
>   * questions.
>   */
>
> +/**
> + * The SunEC security provider.
> + *
> + * @since 9
> + */
>  module jdk.crypto.ec {
>      provides java.security.Provider with sun.security.ec.SunEC;
>  }
> diff --git a/src/jdk.crypto.mscapi/windows/classes/module-info.java
> b/src/jdk.crypto.mscapi/windows/classes/module-info.java
> --- a/src/jdk.crypto.mscapi/windows/classes/module-info.java
> +++ b/src/jdk.crypto.mscapi/windows/classes/module-info.java
> @@ -23,6 +23,11 @@
>   * questions.
>   */
>
> +/**
> + * The SunMSCAPI security provider.
> + *
> + * @since 9
> + */
>  module jdk.crypto.mscapi {
>      provides java.security.Provider with sun.security.mscapi.SunMSCAPI;
>  }
> diff --git a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
> b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
> --- a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
> +++ b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
> @@ -23,6 +23,11 @@
>   * questions.
>   */
>
> +/**
> + * The OracleUCrypto security provider.
> + *
> + * @since 9
> + */
>  module jdk.crypto.ucrypto {
>      provides java.security.Provider with
> com.oracle.security.ucrypto.UcryptoProvider;
>  }
>
> Thanks
> Max
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR 8175846: Provide javadoc descriptions for jdk.policytool and jdk.crypto.* modules

Vincent Ryan
Your comments look fine to me.


> On 7 Mar 2017, at 14:44, Weijun Wang <[hidden email]> wrote:
>
> Ping again.
>
> On 03/01/2017 09:02 AM, Weijun Wang wrote:
>> Please review the patch below. I don't know if all those jdk.crypto.*
>> modules will be listed in the doc, but it's nice to include a comment.
>>
>> Thanks
>> Max
>>
>> diff --git a/src/jdk.policytool/share/classes/module-info.java
>> b/src/jdk.policytool/share/classes/module-info.java
>> --- a/src/jdk.policytool/share/classes/module-info.java
>> +++ b/src/jdk.policytool/share/classes/module-info.java
>> @@ -23,6 +23,14 @@
>>  * questions.
>>  */
>>
>> +/**
>> + * GUI tool for managing policy files.
>> + *
>> + * @since 9
>> + * @deprecated The policytool tool has been deprecated and
>> + * is planned to be removed in a future release.
>> + */
>> +@Deprecated
>> module jdk.policytool {
>>     requires java.desktop;
>>     requires java.logging;
>>
>> diff --git a/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> b/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> --- a/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> +++ b/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>  * questions.
>>  */
>>
>> +/**
>> + * The SunPKCS11 security provider.
>> + *
>> + * @since 9
>> + */
>> module jdk.crypto.cryptoki {
>>     // Depends on SunEC provider for EC related functionality
>>     requires jdk.crypto.ec;
>> diff --git a/src/jdk.crypto.ec/share/classes/module-info.java
>> b/src/jdk.crypto.ec/share/classes/module-info.java
>> --- a/src/jdk.crypto.ec/share/classes/module-info.java
>> +++ b/src/jdk.crypto.ec/share/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>  * questions.
>>  */
>>
>> +/**
>> + * The SunEC security provider.
>> + *
>> + * @since 9
>> + */
>> module jdk.crypto.ec {
>>     provides java.security.Provider with sun.security.ec.SunEC;
>> }
>> diff --git a/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> b/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> --- a/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> +++ b/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>  * questions.
>>  */
>>
>> +/**
>> + * The SunMSCAPI security provider.
>> + *
>> + * @since 9
>> + */
>> module jdk.crypto.mscapi {
>>     provides java.security.Provider with sun.security.mscapi.SunMSCAPI;
>> }
>> diff --git a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> --- a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> +++ b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>  * questions.
>>  */
>>
>> +/**
>> + * The OracleUCrypto security provider.
>> + *
>> + * @since 9
>> + */
>> module jdk.crypto.ucrypto {
>>     provides java.security.Provider with
>> com.oracle.security.ucrypto.UcryptoProvider;
>> }
>>
>> Thanks
>> Max

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR 8175846: Provide javadoc descriptions for jdk.policytool and jdk.crypto.* modules

Sean Mullan
In reply to this post by Weijun Wang
On 3/7/17 9:44 AM, Weijun Wang wrote:
> Ping again.

Sorry I missed this before you pushed the changeset, but the @Deprecated
annotation for the jdk.policytool module should have "forRemoval=true"
on it, since it scheduled for removal in JDK 10:
https://bugs.openjdk.java.net/browse/JDK-8147400

--Sean

>
> On 03/01/2017 09:02 AM, Weijun Wang wrote:
>> Please review the patch below. I don't know if all those jdk.crypto.*
>> modules will be listed in the doc, but it's nice to include a comment.
>>
>> Thanks
>> Max
>>
>> diff --git a/src/jdk.policytool/share/classes/module-info.java
>> b/src/jdk.policytool/share/classes/module-info.java
>> --- a/src/jdk.policytool/share/classes/module-info.java
>> +++ b/src/jdk.policytool/share/classes/module-info.java
>> @@ -23,6 +23,14 @@
>>   * questions.
>>   */
>>
>> +/**
>> + * GUI tool for managing policy files.
>> + *
>> + * @since 9
>> + * @deprecated The policytool tool has been deprecated and
>> + * is planned to be removed in a future release.
>> + */
>> +@Deprecated
>>  module jdk.policytool {
>>      requires java.desktop;
>>      requires java.logging;
>>
>> diff --git a/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> b/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> --- a/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> +++ b/src/jdk.crypto.cryptoki/share/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>   * questions.
>>   */
>>
>> +/**
>> + * The SunPKCS11 security provider.
>> + *
>> + * @since 9
>> + */
>>  module jdk.crypto.cryptoki {
>>      // Depends on SunEC provider for EC related functionality
>>      requires jdk.crypto.ec;
>> diff --git a/src/jdk.crypto.ec/share/classes/module-info.java
>> b/src/jdk.crypto.ec/share/classes/module-info.java
>> --- a/src/jdk.crypto.ec/share/classes/module-info.java
>> +++ b/src/jdk.crypto.ec/share/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>   * questions.
>>   */
>>
>> +/**
>> + * The SunEC security provider.
>> + *
>> + * @since 9
>> + */
>>  module jdk.crypto.ec {
>>      provides java.security.Provider with sun.security.ec.SunEC;
>>  }
>> diff --git a/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> b/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> --- a/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> +++ b/src/jdk.crypto.mscapi/windows/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>   * questions.
>>   */
>>
>> +/**
>> + * The SunMSCAPI security provider.
>> + *
>> + * @since 9
>> + */
>>  module jdk.crypto.mscapi {
>>      provides java.security.Provider with sun.security.mscapi.SunMSCAPI;
>>  }
>> diff --git a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> --- a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> +++ b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>> @@ -23,6 +23,11 @@
>>   * questions.
>>   */
>>
>> +/**
>> + * The OracleUCrypto security provider.
>> + *
>> + * @since 9
>> + */
>>  module jdk.crypto.ucrypto {
>>      provides java.security.Provider with
>> com.oracle.security.ucrypto.UcryptoProvider;
>>  }
>>
>> Thanks
>> Max
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: RFR 8175846: Provide javadoc descriptions for jdk.policytool and jdk.crypto.* modules

Weijun Wang
There was no "forRemoval=true" for the
sun.security.tools.policytool.Main class itself either.

I'll file a bug and add it to both.

Thanks
Max

On 03/08/2017 12:07 AM, Sean Mullan wrote:

> On 3/7/17 9:44 AM, Weijun Wang wrote:
>> Ping again.
>
> Sorry I missed this before you pushed the changeset, but the @Deprecated
> annotation for the jdk.policytool module should have "forRemoval=true"
> on it, since it scheduled for removal in JDK 10:
> https://bugs.openjdk.java.net/browse/JDK-8147400
>
> --Sean
>
>>
>> On 03/01/2017 09:02 AM, Weijun Wang wrote:
>>> Please review the patch below. I don't know if all those jdk.crypto.*
>>> modules will be listed in the doc, but it's nice to include a comment.
>>>
>>> Thanks
>>> Max
>>>
>>> diff --git a/src/jdk.policytool/share/classes/module-info.java
>>> b/src/jdk.policytool/share/classes/module-info.java
>>> --- a/src/jdk.policytool/share/classes/module-info.java
>>> +++ b/src/jdk.policytool/share/classes/module-info.java
>>> @@ -23,6 +23,14 @@
>>>   * questions.
>>>   */
>>>
>>> +/**
>>> + * GUI tool for managing policy files.
>>> + *
>>> + * @since 9
>>> + * @deprecated The policytool tool has been deprecated and
>>> + * is planned to be removed in a future release.
>>> + */
>>> +@Deprecated
>>>  module jdk.policytool {
>>>      requires java.desktop;
>>>      requires java.logging;
>>>
>>> diff --git a/src/jdk.crypto.cryptoki/share/classes/module-info.java
>>> b/src/jdk.crypto.cryptoki/share/classes/module-info.java
>>> --- a/src/jdk.crypto.cryptoki/share/classes/module-info.java
>>> +++ b/src/jdk.crypto.cryptoki/share/classes/module-info.java
>>> @@ -23,6 +23,11 @@
>>>   * questions.
>>>   */
>>>
>>> +/**
>>> + * The SunPKCS11 security provider.
>>> + *
>>> + * @since 9
>>> + */
>>>  module jdk.crypto.cryptoki {
>>>      // Depends on SunEC provider for EC related functionality
>>>      requires jdk.crypto.ec;
>>> diff --git a/src/jdk.crypto.ec/share/classes/module-info.java
>>> b/src/jdk.crypto.ec/share/classes/module-info.java
>>> --- a/src/jdk.crypto.ec/share/classes/module-info.java
>>> +++ b/src/jdk.crypto.ec/share/classes/module-info.java
>>> @@ -23,6 +23,11 @@
>>>   * questions.
>>>   */
>>>
>>> +/**
>>> + * The SunEC security provider.
>>> + *
>>> + * @since 9
>>> + */
>>>  module jdk.crypto.ec {
>>>      provides java.security.Provider with sun.security.ec.SunEC;
>>>  }
>>> diff --git a/src/jdk.crypto.mscapi/windows/classes/module-info.java
>>> b/src/jdk.crypto.mscapi/windows/classes/module-info.java
>>> --- a/src/jdk.crypto.mscapi/windows/classes/module-info.java
>>> +++ b/src/jdk.crypto.mscapi/windows/classes/module-info.java
>>> @@ -23,6 +23,11 @@
>>>   * questions.
>>>   */
>>>
>>> +/**
>>> + * The SunMSCAPI security provider.
>>> + *
>>> + * @since 9
>>> + */
>>>  module jdk.crypto.mscapi {
>>>      provides java.security.Provider with sun.security.mscapi.SunMSCAPI;
>>>  }
>>> diff --git a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>>> b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>>> --- a/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>>> +++ b/src/jdk.crypto.ucrypto/solaris/classes/module-info.java
>>> @@ -23,6 +23,11 @@
>>>   * questions.
>>>   */
>>>
>>> +/**
>>> + * The OracleUCrypto security provider.
>>> + *
>>> + * @since 9
>>> + */
>>>  module jdk.crypto.ucrypto {
>>>      provides java.security.Provider with
>>> com.oracle.security.ucrypto.UcryptoProvider;
>>>  }
>>>
>>> Thanks
>>> Max
Loading...