8192973: Adding "Resolution" to javadoc search index

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

8192973: Adding "Resolution" to javadoc search index

Alan Bateman
I'd like to add a search term to the javadoc search to make it easy to
find the Resolution spec. Attached is the proposed patch. In terms we
will need to do the same for service binding.

-Alan

$ hg diff src/java.base/share/classes/java/lang/module/package-info.java
diff -r 0b42613e35bf
src/java.base/share/classes/java/lang/module/package-info.java
--- a/src/java.base/share/classes/java/lang/module/package-info.java Mon
Dec 04 13:24:00 2017 +0530
+++ b/src/java.base/share/classes/java/lang/module/package-info.java Mon
Dec 04 14:32:53 2017 +0000
@@ -34,7 +34,7 @@
   * will cause a {@code NullPointerException}, unless otherwise
specified. </p>
   *
   *
- * <h1><a id="resolution">Resolution</a></h1>
+ * <h1><a id="resolution">{@index "Resolution"}</a></h1>
   *
   * <p> Resolution is the process of computing how modules depend on
each other.
   * The process occurs at compile time and run time. </p>
Reply | Threaded
Open this post in threaded view
|

Re: 8192973: Adding "Resolution" to javadoc search index

Mandy Chung
+1

Mandy

On 12/4/17 6:45 AM, Alan Bateman wrote:

> I'd like to add a search term to the javadoc search to make it easy to
> find the Resolution spec. Attached is the proposed patch. In terms we
> will need to do the same for service binding.
>
> -Alan
>
> $ hg diff src/java.base/share/classes/java/lang/module/package-info.java
> diff -r 0b42613e35bf
> src/java.base/share/classes/java/lang/module/package-info.java
> --- a/src/java.base/share/classes/java/lang/module/package-info.java
> Mon Dec 04 13:24:00 2017 +0530
> +++ b/src/java.base/share/classes/java/lang/module/package-info.java
> Mon Dec 04 14:32:53 2017 +0000
> @@ -34,7 +34,7 @@
>   * will cause a {@code NullPointerException}, unless otherwise
> specified. </p>
>   *
>   *
> - * <h1><a id="resolution">Resolution</a></h1>
> + * <h1><a id="resolution">{@index "Resolution"}</a></h1>
>   *
>   * <p> Resolution is the process of computing how modules depend on
> each other.
>   * The process occurs at compile time and run time. </p>

Reply | Threaded
Open this post in threaded view
|

Re: 8192973: Adding "Resolution" to javadoc search index

Jonathan Gibbons
Is "resolution" too broad a term?  Should the indexed term be more
specific, like "module resolution"?

-- Jon

On 12/04/2017 10:36 AM, mandy chung wrote:

> +1
>
> Mandy
>
> On 12/4/17 6:45 AM, Alan Bateman wrote:
>> I'd like to add a search term to the javadoc search to make it easy
>> to find the Resolution spec. Attached is the proposed patch. In terms
>> we will need to do the same for service binding.
>>
>> -Alan
>>
>> $ hg diff src/java.base/share/classes/java/lang/module/package-info.java
>> diff -r 0b42613e35bf
>> src/java.base/share/classes/java/lang/module/package-info.java
>> --- a/src/java.base/share/classes/java/lang/module/package-info.java
>> Mon Dec 04 13:24:00 2017 +0530
>> +++ b/src/java.base/share/classes/java/lang/module/package-info.java
>> Mon Dec 04 14:32:53 2017 +0000
>> @@ -34,7 +34,7 @@
>>   * will cause a {@code NullPointerException}, unless otherwise
>> specified. </p>
>>   *
>>   *
>> - * <h1><a id="resolution">Resolution</a></h1>
>> + * <h1><a id="resolution">{@index "Resolution"}</a></h1>
>>   *
>>   * <p> Resolution is the process of computing how modules depend on
>> each other.
>>   * The process occurs at compile time and run time. </p>
>

Reply | Threaded
Open this post in threaded view
|

Re: 8192973: Adding "Resolution" to javadoc search index

Alan Bateman


On 04/12/2017 19:24, Jonathan Gibbons wrote:
> Is "resolution" too broad a term?  Should the indexed term be more
> specific, like "module resolution"?
>
> -- Jon
"Module Resolution" is better and avoids it showing up after a list of
types with "Resolution" in the name, thanks. If there are no objections
then I'll go with that.

-Alan