Details

    • Lucene Fields:
      New

      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.

      1. LUCENE-3387.patch
        15 kB
        David Mark Nemeskey
      2. LUCENE-3387.patch
        15 kB
        David Mark Nemeskey

        Activity

        Hide
        David Mark Nemeskey added a comment -

        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.

        Show
        David Mark Nemeskey added a comment - 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.
        Hide
        Robert Muir added a comment -

        thanks, no more javadocs warnings!

        Show
        Robert Muir added a comment - thanks, no more javadocs warnings!
        Hide
        Robert Muir added a comment -

        Thanks David, looks good.

        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?

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

                  <group title="contrib: Queries" packages="org.apache.lucene.search.similar*:org.apache.lucene.search.regex*:org.apache.regexp*"/>
        
        Show
        Robert Muir added a comment - Thanks David, looks good. 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? This is because of an out of date regexp in the javadocs construction. I'll nuke this before committing <group title="contrib: Queries" packages="org.apache.lucene.search.similar*:org.apache.lucene.search.regex*:org.apache.regexp*"/>
        Hide
        David Mark Nemeskey added a comment -

        Fixed a typo.

        Show
        David Mark Nemeskey added a comment - Fixed a typo.
        Hide
        David Mark Nemeskey added a comment -

        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?

        Show
        David Mark Nemeskey added a comment - 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?
        Hide
        David Mark Nemeskey added a comment -

        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.

        Show
        David Mark Nemeskey added a comment - 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.

          People

          • Assignee:
            David Mark Nemeskey
            Reporter:
            David Mark Nemeskey
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Due:
              Created:
              Updated:
              Resolved:

              Development