[jira] [Created] (LUCENE-3387) Get javadoc for the similarities package in shape

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

[jira] [Created] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
Get javadoc for the similarities package in shape
-------------------------------------------------

                 Key: LUCENE-3387
                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
             Project: Lucene - Java
          Issue Type: Sub-task
            Reporter: David Mark Nemeskey
            Assignee: David Mark Nemeskey




--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Updated] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)

     [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Mark Nemeskey updated LUCENE-3387:
----------------------------------------

    Component/s:     (was: modules/examples)
       Due Date: 21/Aug/11
    Description:
1. Create a package.html in the similarities package.
2. Update the javadoc of the search package (package.html mentions Similarity)?
3. Compile the javadoc to see if there are any warnings.
         Labels: gsoc gsoc2011 javadoc  (was: )

> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Updated] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
In reply to this post by Walter (Jira)

     [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Mark Nemeskey updated LUCENE-3387:
----------------------------------------

    Attachment: LUCENE-3387.patch

1. Fixed the javadoc warnings in EasySimilarity.
2. Okapi paper reference added to BM25Similarity.
3. Added package-level javadoc for the similarities package.
4. Moved the "Changing Similarities" part from search to similarities.


> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>         Attachments: LUCENE-3387.patch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
In reply to this post by Walter (Jira)

    [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13088622#comment-13088622 ]

David Mark Nemeskey commented on LUCENE-3387:
---------------------------------------------

The {{similarities}} package shows up in the 'core', even though it is classified as 'contrib' for javadocs-all. However, since the class {{Similarity}} is now in {{similarities}}, shouldn't it be core as well?

> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>         Attachments: LUCENE-3387.patch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Updated] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
In reply to this post by Walter (Jira)

     [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Mark Nemeskey updated LUCENE-3387:
----------------------------------------

    Attachment: LUCENE-3387.patch

Fixed a typo.

> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>         Attachments: LUCENE-3387.patch, LUCENE-3387.patch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
In reply to this post by Walter (Jira)

    [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13089433#comment-13089433 ]

Robert Muir commented on LUCENE-3387:
-------------------------------------

Thanks David, looks good.

{quote}
The similarities package shows up in the 'core', even though it is classified as 'contrib' for javadocs-all. However, since the class Similarity is now in similarities, shouldn't it be core as well?
{quote}

This is because of an out of date regexp in the javadocs construction. I'll nuke this before committing :)

{noformat}
          <group title="contrib: Queries" packages="org.apache.lucene.search.similar*:org.apache.lucene.search.regex*:org.apache.regexp*"/>
{noformat}

> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>         Attachments: LUCENE-3387.patch, LUCENE-3387.patch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Resolved] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
In reply to this post by Walter (Jira)

     [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Muir resolved LUCENE-3387.
---------------------------------

    Resolution: Fixed

thanks, no more javadocs warnings!

> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>         Attachments: LUCENE-3387.patch, LUCENE-3387.patch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (LUCENE-3387) Get javadoc for the similarities package in shape

Walter (Jira)
In reply to this post by Walter (Jira)

    [ https://issues.apache.org/jira/browse/LUCENE-3387?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13089443#comment-13089443 ]

David Mark Nemeskey commented on LUCENE-3387:
---------------------------------------------

bq. This is because of an out of date regexp in the javadocs construction.

I've found that, I just didn't know what to make of it. Since as far as I know a similarities package hadn't existed before I added the new sims, I assumed it was there on purpose.

> Get javadoc for the similarities package in shape
> -------------------------------------------------
>
>                 Key: LUCENE-3387
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3387
>             Project: Lucene - Java
>          Issue Type: Sub-task
>          Components: core/query/scoring, general/javadocs
>            Reporter: David Mark Nemeskey
>            Assignee: David Mark Nemeskey
>              Labels: gsoc, gsoc2011, javadoc
>             Fix For: flexscoring branch
>
>         Attachments: LUCENE-3387.patch, LUCENE-3387.patch
>
>
> 1. Create a package.html in the similarities package.
> 2. Update the javadoc of the search package (package.html mentions Similarity)?
> 3. Compile the javadoc to see if there are any warnings.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]