FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

chore: add missing Javadoc and fix lint violations across all components · patternfly-java/patternfly-java@16bde68 · GitHub

/ patternfly-java Public

Commit 16bde68

Browse files
hpehl
committed
chore: add missing Javadoc and fix lint violations across all components
Add class-level Javadoc to 93 sub-component classes. Fix section separator format and order in ProgressStep, remove duplicate internal section in NavigationItem, fix constructor visibility in Page and Spinner, move that() to end of builder section in Timestamp, and remove extra trailing newline in NotificationBadge. All 51 components now pass pf-lint clean.
1 parent b3ae880 commit 16bde68

164 files changed

Lines changed: 614 additions & 369 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎components/src/main/java/org/patternfly/component/codeblock/CodeBlockAction.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
import static org.patternfly.style.Classes.item;
4141

4242
/** An individual action button within a {@link CodeBlockActions} container. */
43+
/** A code block action within a {@link CodeBlock} component. */
4344
public class CodeBlockAction extends CodeBlockSubComponent<HTMLDivElement, CodeBlockAction> implements
4445
ComponentIcon<HTMLDivElement, CodeBlockAction> {
4546

‎components/src/main/java/org/patternfly/component/codeblock/CodeBlockActions.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import static org.patternfly.style.Classes.component;
2424

2525
/** A container for action buttons displayed in the header of a {@link CodeBlock}. */
26+
/** A code block actions container within a {@link CodeBlock} component. */
2627
public class CodeBlockActions extends CodeBlockSubComponent<HTMLDivElement, CodeBlockActions> {
2728

2829
// ------------------------------------------------------ factory

‎components/src/main/java/org/patternfly/component/codeblock/CodeBlockHeader.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import static org.patternfly.style.Classes.header;
2525

2626
/** The header area of a {@link CodeBlock} component, typically containing {@link CodeBlockActions}. */
27+
/** A code block header within a {@link CodeBlock} component. */
2728
public class CodeBlockHeader extends CodeBlockSubComponent<HTMLDivElement, CodeBlockHeader> {
2829

2930
// ------------------------------------------------------ factory

‎components/src/main/java/org/patternfly/component/drawer/DrawerCloseButton.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import static org.patternfly.style.Classes.drawer;
3030

3131
/** The close button within a {@link DrawerPanelHead}. */
32+
/** A drawer close button within a {@link Drawer} component. */
3233
public class DrawerCloseButton extends DrawerSubComponent<HTMLDivElement, DrawerCloseButton> {
3334

3435
// ------------------------------------------------------ factory

‎components/src/main/java/org/patternfly/component/emptystate/EmptyStateActions.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import static org.patternfly.style.Classes.emptyState;
2424

2525
/** A container for action buttons within an {@link EmptyState} component. */
26+
/** A empty state actions container within a {@link EmptyState} component. */
2627
public class EmptyStateActions extends EmptyStateSubComponent<HTMLDivElement, EmptyStateActions> {
2728

2829
// ------------------------------------------------------ factory

‎components/src/main/java/org/patternfly/component/emptystate/EmptyStateBody.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import static org.patternfly.style.Classes.emptyState;
2626

2727
/** The body content area of an {@link EmptyState} component. */
28+
/** A empty state body within a {@link EmptyState} component. */
2829
public class EmptyStateBody extends EmptyStateSubComponent<HTMLDivElement, EmptyStateBody> implements
2930
ElementTextMethods<HTMLDivElement, EmptyStateBody> {
3031

‎components/src/main/java/org/patternfly/component/emptystate/EmptyStateFooter.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import static org.patternfly.style.Classes.footer;
2626

2727
/** The footer area of an {@link EmptyState} component, typically containing {@link EmptyStateActions}. */
28+
/** A empty state footer within a {@link EmptyState} component. */
2829
public class EmptyStateFooter extends EmptyStateSubComponent<HTMLDivElement, EmptyStateFooter> implements
2930
ElementTextMethods<HTMLDivElement, EmptyStateFooter> {
3031

‎components/src/main/java/org/patternfly/component/expandable/ExpandableSectionContent.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import static org.patternfly.style.Classes.expandableSection;
2727

2828
/** The collapsible content area of an {@link ExpandableSection} component. */
29+
/** A expandable section content area within a {@link ExpandableSection} component. */
2930
public class ExpandableSectionContent extends ExpandableSectionSubComponent<HTMLDivElement, ExpandableSectionContent> implements
3031
ElementTextMethods<HTMLDivElement, ExpandableSectionContent> {
3132

‎components/src/main/java/org/patternfly/component/expandable/ExpandableSectionToggle.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
import static org.patternfly.style.Classes.toggle;
4040

4141
/** The toggle control that expands and collapses an {@link ExpandableSection} component. */
42+
/** A expandable section toggle within a {@link ExpandableSection} component. */
4243
public class ExpandableSectionToggle extends ExpandableSectionSubComponent<HTMLElement, ExpandableSectionToggle> implements
4344
ElementContainerDelegate<HTMLElement, ExpandableSectionToggle> {
4445

‎components/src/main/java/org/patternfly/component/form/CheckboxBody.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import static org.patternfly.style.Classes.component;
2626

2727
/** The body content of a {@link Checkbox} component. */
28+
/** A body content of a checkbox within a {@link Checkbox} component. */
2829
public class CheckboxBody extends CheckboxSubComponent<HTMLElement, CheckboxBody>
2930
implements ElementTextMethods<HTMLElement, CheckboxBody> {
3031

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL