Subject: Re: PL/Java new build plugin
To: Kartik Ohri <kartikohri13@gmail.com>
References: 
 <CAASLQ4Mva7dAXiS_c9OLhV4VzNHF=XNKJosuS5gtZTB6b4TW1Q@mail.gmail.com>
 <5F1664C5.2070700@anastigmatix.net>
 <CAASLQ4PeivyN6DkBPbgYTZmoqoOVdCDwinDFrREsXqZi2HQnWg@mail.gmail.com>
 <5F1735ED.6020707@anastigmatix.net>
 <CAASLQ4Off+PnB8FqKLokKjAkvKbW00=fjH_LxuYJOGp0_C1YAw@mail.gmail.com>
 <CAASLQ4PcU=P4ShuMJOEnQj6p7ZU0VcgJ9St6PMpXcNB_1jPQ+w@mail.gmail.com>
 <5F1753C9.4060500@anastigmatix.net>
 <CAASLQ4P_v7u5z76XWfPmVeBvQtNdraiN0MmsRRfq-eNh1O1aTA@mail.gmail.com>
 <5F175F40.1000905@anastigmatix.net>
 <CAASLQ4Ouw1hCHVtSC5XG7Fb-GoO0YAf4_PwsQc=22CvEzhQo6g@mail.gmail.com>
 <CAASLQ4MfBz2zj5gm-t+OX-8puxJvf8bSneKeUG+NuX=+CbYCLw@mail.gmail.com>
 <5F18C58F.8060204@anastigmatix.net>
 <CAASLQ4NkEDo-UAmqSwUTkCdMu+3WedKCfva5gzNTC45YcWEwNA@mail.gmail.com>
 <5F19C36C.70905@anastigmatix.net>
 <CAASLQ4M_f8cYmxfX5Jqgm9AJHsX62_Cc5pvniXjer4jAZOMOBQ@mail.gmail.com>
 <5F1C734D.1000409@anastigmatix.net>
 <CAASLQ4P+YVjp6cQY7OyDEx+0dOCnEbDWkxN+WJ13MWMg5wxCyw@mail.gmail.com>
Cc: pljava-dev@lists.postgresql.org
From: Chapman Flack <chap@anastigmatix.net>
Message-ID: <5F1C8389.1040100@anastigmatix.net>
Date: Sat, 25 Jul 2020 15:10:01 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101
 Thunderbird/38.7.0
MIME-Version: 1.0
In-Reply-To: 
 <CAASLQ4P+YVjp6cQY7OyDEx+0dOCnEbDWkxN+WJ13MWMg5wxCyw@mail.gmail.com>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 07/25/20 14:05, Kartik Ohri wrote:
> Also, I am trying to run the javadoc tool directly to know how it works but
> am getting some errors. Can you tell me the command I should execute to
> build the docs successfully? I looked up online for tutorials but most
> predate Java 9 and the module system so are not of much help.

I think you can get a basic set of javadocs for the pljava-api subproject,
for example, if you run something like

javadoc \
  --module org.postgresql.pljava \
  --module-source-path org.postgresql.pljava=pljava-api/src/main/java \
  -d /tmp/put-them-here

You can find out what options the maven-javadoc-plugin is using by
adding <debug>true</debug> in its configuration, then running mvn site.

With <debug>, it will leave behind files javadoc.sh, options, argfile
in the apidocs directory. Then you can just see how many options the
plugin put in can be thrown away and it still works.

Of course we'll want some of the options that control what access
levels to show, page headers and footers, that kind of stuff. It's
just that all the lengths the maven plugin goes to trying to micromanage
where javadoc finds the files to document are nothing but trouble.
If you tell it what module to document and where to find it, really,
javadoc can figure out the rest.

I wouldn't mind writing the scripty bits to run javadoc, once there is
a scriptable mojo I can use to do it. Or if you'd like to, that's cool.

Regards,
-Chap