Skip to content
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

Fix javadoc #23

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Fix javadoc #23

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
eaf287c
docs: fix javadoc
javier-godoy Nov 6, 2024
6b4f03c
build: upgrade javadoc plugin to 3.11.1
javier-godoy Nov 6, 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
41 changes: 22 additions & 19 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,25 +306,28 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<phase>verify</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
<configuration>
<quiet>true</quiet>
<doclint>none</doclint>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.11.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
<configuration>
<quiet>true</quiet>
<doclint>none</doclint>
<failOnWarnings>true</failOnWarnings>
paodb marked this conversation as resolved.
Show resolved Hide resolved
<links>
<link>https://javadoc.io/doc/com.vaadin/vaadin-platform-javadoc/${vaadin.version}</link>
</links>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
Expand Down
28 changes: 16 additions & 12 deletions src/main/java/com/flowingcode/vaadin/addons/enhancedtabs/EnhancedTabs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
import com.vaadin.flow.component.dependency.JsModule;
import com.vaadin.flow.component.menubar.MenuBar;
import com.vaadin.flow.component.tabs.Tab;
import com.vaadin.flow.component.tabs.Tabs;
import com.vaadin.flow.router.RouterLink;
import com.vaadin.flow.shared.Registration;
import java.io.Serializable;
Expand All @@ -65,15 +66,17 @@
* Tabs when you want to allow in-place navigation within a certain part of the UI, instead of
* showing everything at once or forcing the user to navigate between different views.
*
* <p>{@link Tab} components can be added to this component with the {@link #add(Tab...)} method or
* the {@link #Tabs(Tab...)} constructor. The Tab components added to it can be selected with the
* {@link #setSelectedIndex(int)} or {@link #setSelectedTab(Tab)} methods. The first added {@link
* Tab} component will be automatically selected, firing a {@link SelectedChangeEvent}, unless
* autoselection is explicitly disabled with {@link #Tabs(boolean, Tab...)}, or {@link
* #setAutoselect(boolean)}. Removing the selected tab from the component changes the selection to
* the next available tab.
* <p>
* {@link Tab} components can be added to this component with the {@link #add(Tab...)} method or the
* {@link Tabs#Tabs(Tab...)} constructor. The Tab components added to it can be selected with the
* {@link #setSelectedIndex(int)} or {@link #setSelectedTab(Tab)} methods. The first added
* {@link Tab} component will be automatically selected, firing a {@link SelectedChangeEvent},
* unless autoselection is explicitly disabled with {@link Tabs#Tabs(boolean, Tab...)}, or
* {@link #setAutoselect(boolean)}. Removing the selected tab from the component changes the
* selection to the next available tab.
*
* <p><strong>Note:</strong> Adding or removing Tab components via the Element API, eg. {@code
* <p>
* <strong>Note:</strong> Adding or removing Tab components via the Element API, eg. {@code
* tabs.getElement().insertChild(0, tab.getElement()); }, doesn't update the selected index, so it
* may cause the selected tab to change unexpectedly.
*/
Expand Down Expand Up @@ -160,10 +163,11 @@ public EnhancedTabs(boolean autoselect, Tab... tabs) {
/**
* Adds the given tabs to the component.
*
* <p>The first added {@link Tab} component will be automatically selected, unless auto-selection
* is explicitly disabled with {@link #Tabs(boolean, Tab...)}, or {@link #setAutoselect(boolean)}.
* If a selection change listener has been added before adding the tabs, it will be notified with
* the auto-selected tab.
* <p>
* The first added {@link Tab} component will be automatically selected, unless auto-selection is
* explicitly disabled with {@link Tabs#Tabs(boolean, Tab...)}, or
* {@link #setAutoselect(boolean)}. If a selection change listener has been added before adding
* the tabs, it will be notified with the auto-selected tab.
*
* @param tabs the tabs to enclose
*/
Expand Down
Loading