Skip to content

Commit ce15664

Browse files
authored
Add help topic to settings (#8443)
Update the help topic in for the Bazel settings in preparation for the new documentation.
1 parent ef75cef commit ce15664

1 file changed

Lines changed: 8 additions & 22 deletions

File tree

base/src/com/google/idea/blaze/base/settings/ui/BlazeUserSettingsCompositeConfigurable.java

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@
3030
import com.intellij.ui.components.panels.VerticalLayout;
3131
import java.util.Arrays;
3232
import java.util.List;
33-
import javax.annotation.Nullable;
3433
import javax.swing.JComponent;
3534
import javax.swing.JPanel;
35+
import org.jetbrains.annotations.NonNls;
36+
import org.jetbrains.annotations.Nullable;
3637

3738
/** Settings configurable combining settings from multiple nested configurables. */
3839
public class BlazeUserSettingsCompositeConfigurable
@@ -50,6 +51,7 @@ public interface UiContributor {
5051

5152
public static final String ID = "blaze.view";
5253
private static final String DISPLAY_NAME = Blaze.defaultBuildSystemName() + " Settings";
54+
private static final String HELP_TOPIC = "reference.bazel";
5355

5456
@Override
5557
public String getId() {
@@ -61,6 +63,11 @@ public String getDisplayName() {
6163
return DISPLAY_NAME;
6264
}
6365

66+
@Override
67+
public @Nullable @NonNls String getHelpTopic() {
68+
return HELP_TOPIC;
69+
}
70+
6471
@Override
6572
public JComponent createComponent() {
6673
JPanel panel = new JPanel(new VerticalLayout(/* gap= */ 0));
@@ -89,25 +96,4 @@ public void processOptions(SearchableOptionProcessor processor) {
8996
.forEach(helper::registerText);
9097
}
9198
}
92-
93-
/**
94-
* Used if the settings are not applicable for the user's configuration. This ensures that no
95-
* artifacts affect the UI.
96-
*/
97-
public static final UnnamedConfigurable EMPTY_CONFIGURABLE =
98-
new UnnamedConfigurable() {
99-
@Override
100-
@Nullable
101-
public JComponent createComponent() {
102-
return null;
103-
}
104-
105-
@Override
106-
public boolean isModified() {
107-
return false;
108-
}
109-
110-
@Override
111-
public void apply() {}
112-
};
11399
}

0 commit comments

Comments
 (0)