Project

General

Profile

Actions
Copy link

Bug #13318

closed

Tidy up libdtrace_jni javadoc

Added by Peter Tribble 9 months ago. Updated 2 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Peter Tribble
Category:
DTrace
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:
1066

Description

If, as discussed in #13315, we move to publishing javadoc rather than packaging it, we should make sure it's reasonably error free.

Specifically, for libdtrace_jni:

@inheritDoc should be inside {}

The docs.sun.com URLs don't work any more; we should use http://dtrace.org/guide/ (also in the Quick Start Guide)

It's not Solaris

And there are some typos that cause javadoc to complain

It is not the intention of this bug to fix all the warnings, that are usually related to missing javadoc comments for parameters

Actions
Copy link
 #1

Updated by Electric Monk 9 months ago

  • Gerrit CR set to 1066
Actions
Copy link
 #2

Updated by Peter Tribble 7 months ago

For testing: I've generated javadoc using both java 8 and java 11. This is
also available to view at

https://pkgs.tribblix.org/javadoc/8/dtrace/index.html
https://pkgs.tribblix.org/javadoc/11/dtrace/index.html

Actions
Copy link
 #3

Updated by Electric Monk 2 months ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit 3a9318192067bc7735a0a8b261c598c7d4129177

commit  3a9318192067bc7735a0a8b261c598c7d4129177
Author: Peter Tribble <peter.tribble@gmail.com>
Date:   2021-05-31T18:17:29.000Z

    13318 Tidy up libdtrace_jni javadoc
    Reviewed by: Toomas Soome <tsoome@me.com>
    Reviewed by: Andy Fiddaman <andy@omniosce.org>
    Reviewed by: Gergő Mihály Doma <domag02@gmail.com>
    Approved by: Robert Mustacchi <rm@fingolfin.org>

Actions
Copy link

Also available in: Atom PDF