Skip to content

Commit d0a9ffa

Browse files
Various Javadoc fixes to address Javadoc NPE failure.
1 parent 6e2d272 commit d0a9ffa

File tree

10 files changed

+70
-87
lines changed

10 files changed

+70
-87
lines changed

src/org/freedesktop/gstreamer/Bin.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2021 Neil C Smith
2+
* Copyright (c) 2025 Neil C Smith
33
* Copyright (c) 2016 Christophe Lafolet
44
* Copyright (c) 2009 Levente Farkas
55
* Copyright (C) 2007 Wayne Meissner
@@ -496,7 +496,7 @@ public void disconnect(DO_LATENCY listener) {
496496

497497
/**
498498
* Available details for pipeline graphs produced by
499-
* {@link #debugToDotFile(int, java.lang.String, boolean)}
499+
* {@link #debugToDotFile(java.util.EnumSet, java.lang.String)}
500500
*/
501501
public static enum DebugGraphDetails implements NativeFlags<DebugGraphDetails> {
502502

src/org/freedesktop/gstreamer/Bus.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2020 Neil C Smith
2+
* Copyright (c) 2025 Neil C Smith
33
* Copyright (C) 2014 Tom Greenwood <[email protected]>
44
* Copyright (C) 2007 Wayne Meissner
55
* Copyright (C) 2004 Wim Taymans <[email protected]>
@@ -33,6 +33,7 @@
3333
import com.sun.jna.ptr.IntByReference;
3434
import com.sun.jna.ptr.LongByReference;
3535
import com.sun.jna.ptr.PointerByReference;
36+
import org.freedesktop.gstreamer.glib.GObject;
3637
import org.freedesktop.gstreamer.glib.NativeEnum;
3738

3839
import org.freedesktop.gstreamer.glib.Natives;
@@ -766,9 +767,10 @@ public static interface BUFFERING {
766767
* {@code percent} is a value between 0 and 100. A value of 100 means
767768
* that the buffering completed.
768769
* <p>
769-
* When {@code percent} is < 100 the application should PAUSE a PLAYING
770-
* pipeline. When {@code percent} is 100, the application can set the
771-
* pipeline (back) to PLAYING. <p>
770+
* When {@code percent} is less than 100 the application should PAUSE a
771+
* PLAYING pipeline. When {@code percent} is 100, the application can
772+
* set the pipeline (back) to PLAYING.
773+
* <p>
772774
* The application must be prepared to receive BUFFERING messages in the
773775
* PREROLLING state and may only set the pipeline to PLAYING after
774776
* receiving a message with {@code percent} set to 100, which can happen

src/org/freedesktop/gstreamer/BusSyncReply.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019 Neil C Smith
2+
* Copyright (c) 2025 Neil C Smith
33
* Copyright (c) 2007 Wayne Meissner
44
*
55
* This file is part of gstreamer-java.
@@ -20,6 +20,7 @@
2020
package org.freedesktop.gstreamer;
2121

2222
import org.freedesktop.gstreamer.glib.NativeEnum;
23+
import org.freedesktop.gstreamer.message.Message;
2324

2425
/**
2526
* The result values for a GstBusSyncHandler.

src/org/freedesktop/gstreamer/Caps.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019 Neil C Smith
2+
* Copyright (c) 2025 Neil C Smith
33
* Copyright (c) 2009 Levente Farkas
44
* Copyright (C) 2007 Wayne Meissner
55
* Copyright (C) <2003> David A. Schleef <[email protected]>
@@ -38,12 +38,12 @@
3838
* given pad can handle. They are also stored in the {@link Registry} along with
3939
* a description of the {@link Element}.
4040
* <p>
41-
* Caps are exposed on the element pads using the {@link Pad#getCaps} method.
42-
* This method describes the possible types that the pad can handle or produce
43-
* at runtime.
41+
* Caps are exposed on the element pads using the {@link Pad#getAllowedCaps() }
42+
* method. This method describes the possible types that the pad can handle or
43+
* produce at runtime.
4444
* <p>
4545
* Caps are also attached to buffers to describe the content of the data pointed
46-
* to by the buffer with {@link Buffer#setCaps}. Caps attached to a
46+
* to by the buffer with {@link Sample#setCaps}. Caps attached to a
4747
* {@link Buffer} allow for format negotiation upstream and downstream.
4848
* <p>
4949
* A Caps can be constructed with the following code fragment:

src/org/freedesktop/gstreamer/ClockID.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019 Neil C Smith
2+
* Copyright (c) 2025 Neil C Smith
33
* Copyright (c) 2007 Wayne Meissner
44
*
55
* This file is part of gstreamer-java.
@@ -57,7 +57,8 @@ public long getTime() {
5757
* Compares this ClockID to another.
5858
*
5959
* @param other The other ClockID to compare to
60-
* @return negative value if a < b; zero if a = b; positive value if a > b
60+
* @return negative value if
61+
* {@code a < b; zero if a = b; positive value if a > b}
6162
*/
6263
@Override
6364
public int compareTo(ClockID other) {

src/org/freedesktop/gstreamer/Context.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/*
2+
* Copyright (c) 2025 Neil C Smith
23
* Copyright (c) 2019 Christophe Lafolet
34
*
45
* This file is part of gstreamer-java.
@@ -54,7 +55,7 @@
5455
* application should provide one if it can.
5556
* <p>
5657
* Contexts can be persistent. A persistent context is kept in elements when
57-
* they reach {@lin State#NULL}, non-persistent ones will be removed. Also, a
58+
* they reach {@link State#NULL}, non-persistent ones will be removed. Also, a
5859
* non-persistent context won't override a previous persistent context set to an
5960
* element.
6061
*/

0 commit comments

Comments
 (0)