Skip to content

8329717: Missing @since tags in elements in DocumentationTool and Taglet #18640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

8329717: Missing @since tags in elements in DocumentationTool and Taglet #18640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ffee11
add `@since` to `SNIPPET_PATH` and `isBlockTag()`
nizarbenalla Apr 4, 2024
0c5a300
add blank line
nizarbenalla Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/java.compiler/share/classes/javax/tools/DocumentationTool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2024, 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
Expand Down Expand Up @@ -188,6 +188,8 @@ enum Location implements JavaFileManager.Location {

/**
* Location to search for snippets.
*
* @since 18
*/
SNIPPET_PATH;

Expand Down
4 changes: 3 additions & 1 deletion src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Taglet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2001, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2001, 2024, 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
Expand Down Expand Up @@ -96,6 +96,8 @@ public interface Taglet {
* @return true if this taglet supports block tags
* @implSpec This implementation returns the inverse
* result to {@code isInlineTag}.
*
* @since 15
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might as well insert a blank line above.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, looking at the existing source code sometimes I find a blank line and sometimes I don't.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood; my comment was a mild suggestion, not a requirement. I find it easier to read when @since is set off with a blank line.

*/
default boolean isBlockTag() {
return !isInlineTag();
Expand Down