Hi javadoc folk,
This is a bug report. On my Ubuntu system, using recent lambda-dev
binaries, I see this:
$ man javadoc > /dev/null
:29: warning [p 1, 1.8i]: cannot adjust line
:1556: warning [p 20, 10.3i, div `b+', 0.7i]: can't break
line
:1556: warning [p 20, 10.3i, div `c+', 0.7i]: can't brea
At Google we also strive for repeatable builds. We find timestamps
embedded in jar files to be the biggest problem.
Timestamps are useful for users checking up-to-dateness via the "Show
Source" action in a web browser.
Making the choice of timestamp explicit in a javadoc invocation seems like
a
On Thu, Jul 24, 2014 at 8:28 AM, Benedikt Morbach
wrote:
> > At Google we also strive for repeatable builds. We find timestamps
> > embedded in jar files to be the biggest problem.
> >
> > Timestamps are useful for users checking up-to-dateness via the "Show
> > Source" action in a web browser.
On Thu, Jul 24, 2014 at 10:34 AM, Benedikt Morbach
wrote:
>
> >
> > It depends. My own most-read javadoc is
> >
> http://gee.cs.oswego.edu/dl/jsr166/dist/docs/java/util/concurrent/CompletableFuture.html
> > and that has no release version associated with it. The value of the
> > timestamps may be
On Mon, Jul 28, 2014 at 1:50 AM, bmorbach wrote:
> On Fri, 2014-07-25 at 16:02 -0700, Martin Buchholz wrote:
>
> > I'm mainly arguing that for most use cases, omitting the
> > timestamp wouldn't hurt/would be better.
> > Doing this up
[+javadoc-dev]
On Fri, Jan 23, 2015 at 1:20 PM, Brian Burkhalter <
brian.burkhal...@oracle.com> wrote:
> On Jan 23, 2015, at 1:10 PM, Martin Buchholz wrote:
>
> We have struggled for years with formatting for code samples. If you want
> to change it, get authoritative stateme
Hi jigsaw/javadoc folk,
I'm trying to update jsr166 CVS to latest jdks and failing.
If I run "ant docs" with a -Djdk9.home pointing at jdk-9+110 binaries
and -Djdk9.src.dir pointing at openjdk9 tip sources, I get:
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet (Next)
.g. including repo paths)
>
> -- Jon
>
>
> On 03/24/2016 04:10 PM, Martin Buchholz wrote:
>>
>> Hi jigsaw/javadoc folk,
>>
>> I'm trying to update jsr166 CVS to latest jdks and failing.
>>
>> If I run "ant docs" with a -Djdk9.home po
8:50 PM, Martin Buchholz wrote:
> (last minute fiddling with ant properties ... hope this works:)
>
> cvs -Q -d ':pserver:anonymous:@gee.cs.oswego.edu/home/jsr166/jsr166'
> checkout jsr166 && cd jsr166 && ant -Djdk9.home="$JDK9_IMAGE"
> -Djdk9.s
I'm not really qualified, but here are random comments:
I think the general idea is right - javac and javadoc need the same
kind of support for modules.
I worry that details may be different, e.g. javadoc has diamond
inheritance and pulls in via @{inheritDoc} part of the
"implementation" from modu
On Mon, Apr 11, 2016 at 3:57 PM, Jonathan Gibbons
wrote:
>
>
> On 04/07/2016 10:04 PM, Martin Buchholz wrote:
>>
>> I'm not really qualified, but here are random comments:
>>
>> I think the general idea is right - javac and javadoc need the same
>>
ates our
http://gee.cs.oswego.edu/dl/jsr166/dist/docs/
and jsr166 maintainers can do the rest.
On Mon, Apr 11, 2016 at 4:35 PM, Jonathan Gibbons
wrote:
>
>
> On 04/11/2016 04:12 PM, Martin Buchholz wrote:
>>
>> On Mon, Apr 11, 2016 at 3:57 PM, Jonathan Gibbons
>> wrote:
&g
On Fri, Apr 15, 2016 at 8:17 AM, Kumar Srinivasan
wrote:
>
> Martin,
>
> The bug 8152818 was pushed last night, below is a recipe
> to build jsr166's API doc. Please note, this is not an optimal
> solution, and also encountered a javac issue JDK-8154152,
> also we are in discussion on a simple
Below is a script that successfully processes all of the jsr166 source
files, but ignores JDK sources and so all of the {@inheritDoc} are
left blank, which is a regression.
I couldn't find any way to get javadoc to warn me if the {@inheritDoc}
snippets could not be filled in (sort of a "linker err
Here's a variant where I try adding -modulesearchpath pointing at the
jdk sources.
It fails with the error
java/util/PriorityQueue.java:26: error: unnamed package is not allowed
in named modules
package java.util;
^
... but that's nonsensical - this is not an unnamed package. That's
the package
If I try to pull in @inheritDoc sources using -sourcepath instead of
-modulesourcepath, I get
java/util/ArrayPrefixHelpers.java:7: error: illegal combination of
-Xmodule and module-info on classpath
package java.util;
^
java.lang.AssertionError
at
com.sun.tools.javac.util.Assert.error(jdk.compile
A final and successful (but disappointing) experiment.
Copying the JDK sources, deleting the module-info.java file and using
the traditional -sourcepath flag with that brings success.
It's disappointing because it's clearly an ugly hack and retreating to
a pre-jigsaw world (but -Xmodule:java.base
One more non-gripe!
If I leave the references to sun.misc.Unsafe (instead of the
jdk.internal variant) I get:
java/util/concurrent/atomic/AtomicLong.java:28: error: package
sun.misc does not exist
private static final sun.misc.Unsafe U = sun.misc.Unsafe.getUnsafe();
But I notice that the arch
On Mon, Apr 18, 2016 at 11:11 AM, Jonathan Gibbons
wrote:
>
>
> On 04/16/2016 03:45 PM, Martin Buchholz wrote:
>>
>> exec $JDK/bin/javadoc \
>>-d docs \
>>-Xdoclint:all \
>>-Xmodule:java.base \
>>-modulesourcepath "$JDKSRC/jdk
Hi Kumar,
Is this intended to address the jsr166 use case (source files belong to a
module, but not the entire module is being processed, and not all module
sources are in a single tree)?
Currently, jsr166 CVS docs are still broken. "ant docs" fails with
[javadoc] java.lang.AssertionError
[j
Hi,
I'm still trying and failing to get our jsr166 docs target to work with
jdk9 sources (to have @inheritDoc work)
And I'm still unclear on how this is expected to work.
My latest try (with jdk9+139) fails as below. I can understand javadoc
doesn't like mixing modular and non-modular sources, b
Hi,
I think CODETOOLS-7901742 was mistakenly filed in CODETOOLS inistead of
JDK/tools/javadoc. And there doesn't seem to be any way to move a bug
report between projects. Can someone here (jjg?) triage this lost bug?
:
> Martin,
>
> Does this mean you oppose this change until all Javadoc compiles cleanly
> with doclint html5?
>
> /Magnus
>
> 22 apr. 2017 kl. 19:11 skrev Martin Buchholz :
>
> It seems our javadoc is using html constructs that are not valid html5.
> If so, we s
On Mon, Apr 24, 2017 at 5:06 PM, Jonathan Gibbons <
jonathan.gibb...@oracle.com> wrote:
> There is also a very strong desire to move to HTML 5 for the JDK
> documentation to be able to make use of the accessibility features that are
> available.
>
OK, that's a good reason to do it sooner rather th
This seems to break the build
* For target
buildtools_interim_langtools_modules_jdk.javadoc.interim__the.BUILD_jdk.javadoc.interim_batch:
/home/martin/ws/jdk/src/jdk.javadoc/share/classes/com/sun/tools/javadoc/main/SourcePositionImpl.java:31:
warning: [removal] SourcePosition in com.sun.javadoc ha
a related javac fix that went back a few days ago, from Jan
> Lahoda. Is it possible that either you didn't pick up that fix, or that you
> have a locally modified copy of javadoc that needs to be updated?
>
> -- Jon
>
>
> On 02/09/2018 04:06 PM
OK, I get it now. jdk tip needs
http://hg.openjdk.java.net/jdk/jdk10/rev/107413b070b9 *in the bootstrap* to
bootstrap with jdk10, but that is coming out as part of jdk-10+43, which
hasn't been released yet. So this will fix itself over time. I can
confirm that jdk tip bootstraps with jdk 10 tip a
The new SEARCH: box recently added to api docs e.g.
https://download.java.net/java/early_access/jdk11/docs/api/overview-summary.html
is *awesome* (thanks!) and I would like to embed those SEARCH: boxes in my
own home page, and I'm guessing I'm not the only one. Do you have a
snippet of html to off
Google search seems to do a lousy job of crawling the jdk10 javadocs.
E.g. a Google search for
site:https://docs.oracle.com/javase/10/docs inurl:ArrayList
comes up empty
Who do I complain to? Could there be a robots.txt file?
On Tue, Mar 27, 2018 at 4:35 PM, Jonathan Gibbons <
jonathan.gibb...@oracle.com> wrote:
> Martin,
>
> This seems to have resolved itself. Maybe "Google search" finally read
> the release announcement ;-)
>
Maybe "Google search" was reading this thread and made this specific
search succeed just
On Mon, Jun 4, 2018 at 2:11 PM, Jonathan Gibbons <
jonathan.gibb...@oracle.com> wrote:
> JDK-8196202 [1] introduced a change to the javadoc tool (and because of
> that, to the Java SE API documentation) such that frames are not generated
> by default.
>
> This has had a deliberate but somewhat une
TIL about Canonical link element and 301 redirects. You get to decide
whether to follow the joint advice of Google and Microsoft
https://en.wikipedia.org/wiki/HTTP_301#Search_engines
On Mon, Jun 4, 2018 at 3:45 PM, Jonathan Gibbons <
jonathan.gibb...@oracle.com> wrote:
>
>
> On 06/04/2018 03:39
I was trying to migrate to using the shiny
https://docs.oracle.com/en/java/javase/11/
for all my documentation needs and ran into some troubles:
Every year I complain about no one checking for dead links in the docs.
Running a dead-link checker before a major release should be easy-peasy.
E.g. in
I found
https://bugs.openjdk.java.net/browse/JDK-8211194
javadoc -link doesn't take module path into consideration
and raised the priority of that bug.
On Wed, Sep 26, 2018 at 6:47 PM, Martin Buchholz
wrote:
> I was trying to migrate to using the shiny
> https://docs.oracle.com/en/
wrote:
> This appear to be a dup of [1], we will verify and make sure it is before
> closing the issue as such. Also, we will evaluate the backport.
>
> -Michel
>
> [1] https://bugs.openjdk.java.net/browse/JDK-8205593
>
>
> On Sep 30, 2018, at 9:56 PM, Martin Buch
Now that jdk-12+14 is out, using the jdk12 javadoc command to generate docs
linking to jdk11 external docs works well!
Doug, you will probably need to update your jdk12 to jdk-12+14 and
regenerate jsr166 docs.
On Mon, Oct 1, 2018 at 3:40 PM, Martin Buchholz wrote:
> I am a lot happier af
Maybe not quite what you want, but:
- javadoc search is awesome!
- I'd like a snippet of html so I can embed a doc search box in my own home
page.
- I'd like (browser-specific) instructions so that I can do a search from
my browser's address bar.
- I'd like a help button so I can easily look up the
>
>
>
> > - If I right-mouse-click on "SEARCH" the previous word "METHOD" is also
> highlighted, and Chrome offers to do a Google search on "METHODSEARCH"
> ("""did you mean METHOD SEARCH?""" Nope.)
>
> I don’t see the word „METHOD“ anywhere, but why would you want to search
> for it on Google?
>
>
On Sat, Feb 2, 2019 at 6:02 PM Jonathan Gibbons
wrote:
>
> On 1/30/19 12:46 PM, Martin Buchholz wrote:
>
> Maybe not quite what you want, but:
> - javadoc search is awesome!
> - I'd like a snippet of html so I can embed a doc search box in my own
> home page.
>
&
Backport did not apply cleanly, but seemed straight forward.
https://cr.openjdk.java.net/~martin/webrevs/jdk11/JDK-8212233-backport/
https://bugs.openjdk.java.net/browse/JDK-8212233
https://jdk.java.net/13/ points to
https://download.java.net/java/early_access/jdk13/docs/api/
but that's a 404
Similarly for
https://jdk.java.net/12/ =>
https://download.java.net/java/early_access/jdk12/docs/api/
Oh, yeah, right - Thursdays.
Too much trouble to implement atomic switchover to next version?
On Thu, Feb 14, 2019 at 10:54 AM Tim Bell wrote:
> Martin wrote:
>
> > https://jdk.java.net/13/ points to
> > https://download.java.net/java/early_access/jdk13/docs/api/
> > but that's a 404
> >
> > Si
Content Delivery Networks are supposed to be about High Availability (and
performance), but you can't have High Availability for the actual content
without atomic updates.
javadoc apis are used by various automated processes, notably javadoc -link
On Thu, Feb 14, 2019 at 1:37 PM Tim Bell wrote:
kport record in JIRA.
I don't know why my bug fix apparently does not resolve the serious
maven-related problems seen in jdk11.
My own backport seems to "work", but I don't whether an actual important
bug is being fixed.
On Mon, Feb 4, 2019 at 1:20 PM Martin Buchholz wrote:
> Ba
wrote:
> On 2/18/19 6:51 PM, Martin Buchholz wrote:
> > Over in
> https://mail.openjdk.java.net/pipermail/jdk-updates-dev/2019-February/000452.html
> you
> > volunteered to look at javadoc problems, and this bug is one of them, so
> perhaps you can add it
> > to your list
Sigh.
On Mon, Feb 18, 2019 at 11:07 AM Aleksey Shipilev wrote:
> On 2/18/19 8:02 PM, Martin Buchholz wrote:
> > I am trying to follow the process - this thread is the RFR for 11u !
>
> No, it is not.
>
> Please put yourself into the shoes of reviewers and maintainers: th
Thanks, Robert.
On Mon, Feb 18, 2019 at 11:15 AM Robert Scholte
wrote:
> We're close to a new release of the javadoc-maven-plugin
>
Did you mean maven-javadoc-plugin ?
> , which will have support for javadoc with the modular system.
>
So perhaps we don't need to fix jdk11 at all, and just ad
Sorry to keep complaining, but this week I have a slightly different
problem.
I've been using the URL
https://download.java.net/java/early_access/jdk13/docs/api/
which, although not stable long term, has at least been stable from build
to build.
It seems today I need to access the URL
https://downl
Relatedly, today I noticed warnings for missing comments on non-public
elements with javadoc16 that did not appear in javadoc11.
CompletableFuture.java:1718: warning: no comment
static final class AsyncSupply extends ForkJoinTask
^
Naturally I added the flag -Xdoclint:all,-mi
20 at 11:51 AM Pavel Rappo wrote:
>
> One can invoke DocLint in several different ways. Depending on the way they
> choose, the behaviour will slightly differ.
>
> To understand what happens, I need to know how you invoke DocLint. Would you
> be able to provide the exact command
27;t want to write comments in javadoc format, don't run
> > javadoc
> > on those comments!
> >
> > -- Jon
> >
> > On 6/19/20 11:27 AM, Martin Buchholz wrote:
> >> Relatedly, today I noticed warnings for missing comments on non-public
51 matches
Mail list logo
