archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 06:45:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8342466: Improve API documentation for java.lang.classfile.attribute

Browse source 
Reviewed-by: darcy, asotona
This commit is contained in:
Chen Liang 2025-01-15 02:04:01 +00:00
parent 9782bfdd27
commit 973c630777
70 changed files with 2443 additions and 967 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/java.base/share/classes/java/lang/classfile/attribute/LineNumberInfo.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2025, 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
@ -24,11 +24,16 @@
*/
package java.lang.classfile.attribute;
import java.lang.classfile.CodeBuilder;
import java.lang.classfile.instruction.LineNumber;
import jdk.internal.classfile.impl.UnboundAttribute;
/**
* Models a single line number in the {@link LineNumberTableAttribute}.
* Models a single line number entry in the {@link LineNumberTableAttribute}.
*
* @see LineNumberTableAttribute#lineNumbers()
* @see LineNumber
* @since 24
*/
public sealed interface LineNumberInfo
@ -47,6 +52,12 @@ public sealed interface LineNumberInfo
/**
* {@return a line number description}
*
* @apiNote
* The created entry cannot be written to a {@link CodeBuilder}. Call
* {@link CodeBuilder#lineNumber CodeBuilder::lineNumber} in the correct
* order instead.
*
* @param startPc the starting index of the code array for this line
* @param lineNumber the line number within the original source file
*/