Uploaded image for project: 'Legal Discuss'
  1. Legal Discuss
  2. LEGAL-529

Can modern javadoc be distributable in Apache artifacts or served from Apache project sites?

    XMLWordPrintableJSON

Details

    • Question
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None

    Description

      Since java 9 a modern style of javadoc has been available that uses a search functionality instead of frames. I believe in recent java releases this is the only choice; it's certainly the default.  The search works through the inclusion of a javascript file, search.js, with the following header:

      ```

      /*

      • Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
      • DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
        *
      • This code is free software; you can redistribute it and/or modify it
      • under the terms of the GNU General Public License version 2 only, as
      • published by the Free Software Foundation. Oracle designates this
      • particular file as subject to the "Classpath" exception as provided
      • by Oracle in the LICENSE file that accompanied this code.
        *
      • This code is distributed in the hope that it will be useful, but WITHOUT
      • ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
      • FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
      • version 2 for more details (a copy is included in the LICENSE file that
      • accompanied this code).
        *
      • You should have received a copy of the GNU General Public License version
      • 2 along with this work; if not, write to the Free Software Foundation,
      • Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
        *
      • Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
      • or visit www.oracle.com if you need additional information or have any
      • questions.
        */

      ```

       

      I'll note that as far as I can tell, no LICENSE file is included in the generated javadoc.

       

      Some other javascript from jQuery is also used, but that is MIT licensed.

       

      For a normal java  or javascript project (there might be some way to construct a project where the following is not the case, but I can't imagine what it is) this search.js file is not part of the source, the build, or any convenience binaries related to running the project's code; it's only part of generated documentation. It will only be executed in a user's browser while viewing javadoc.

       

      Can javadoc including this file be made available as a release artifact? (For instance as part of a maven-built javadoc jar)

       

      Can javadoc including this file be included in a project website served from Apache with an apache url?

       

      If the answers to the above are "no" are there any conceptual problems with writing and using a MIT or AL2 licensed replacement, possibly hosted outside Apache?

      Attachments

        Activity

          People

            Unassigned Unassigned
            djencks David Jencks
            Votes:
            0 Vote for this issue
            Watchers:
            9 Start watching this issue

            Dates

              Created:
              Updated: