Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-1051

Separate javadocs for core and contribs

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.3
    • Component/s: general/javadocs
    • Labels:
      None
    • Lucene Fields:
      New, Patch Available

      Description

      A while ago we had a discussion on java-dev about separating the javadocs
      for the contrib modules instead of having only one big javadoc containing
      the core and contrib classes.

      This patch:

      • Adds new targets to build.xml:
        • "javadocs-all" Generates Javadocs for the core, demo, and contrib
          classes
        • "javadocs-core" Generates Javadocs for the core classes
        • "javadocs-demo" Generates Javadocs for the demo classes
        • "javadocs-contrib" Using contrib-crawl it generates the Javadocs for
          all contrib modules, except "similarity" (currently empty) and gdata.
      • Adds submenues to the Javadocs link on the Lucene site with links to
        the different javadocs
      • Includes the javadocs in the maven artifacts

      Remarks:

      • I removed the ant target "javadocs-internal", because I didn't want to
        add corresponding targets for all new javadocs target. Instead I
        defined a new property "javadoc.access", so now
        "ant -Djavadoc.access=package" can be used in combination with any of
        the javadocs targets. Is this ok?
      • I didn't include gdata (yet) because it uses build files that don't
        extend Lucenes standard build files.

      Here's a preview:
      http://people.apache.org/~buschmi/site-preview/index.html

      Please let me know what you think about these changes!

        Attachments

        1. lucene-1051-take2.patch
          23 kB
          Michael Busch
        2. lucene-1051.patch
          23 kB
          Michael Busch

          Issue Links

            Activity

              People

              • Assignee:
                michaelbusch Michael Busch
                Reporter:
                michaelbusch Michael Busch
              • Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: