[
https://issues.apache.org/jira/browse/FLINK-5781?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16000845#comment-16000845
]
ASF GitHub Bot commented on FLINK-5781:
---------------------------------------
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/3495#discussion_r115264951
--- Diff:
flink-core/src/test/java/org/apache/flink/configuration/ConfigOptionsDocGeneratorTest.java
---
@@ -0,0 +1,69 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.flink.configuration;
+
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+public class ConfigOptionsDocGeneratorTest {
+
+ public static class TestConfigGroup {
+ public static ConfigOption<Integer> firstOption = ConfigOptions
+ .key("first.option.a")
+ .defaultValue(2)
+ .withDescription("This is example description for the
first option.");
+
+ public static ConfigOption<String> secondOption = ConfigOptions
+ .key("second.option.a")
+ .noDefaultValue()
+ .withDescription("This is long example description for
the second option.");
+
+ private TestConfigGroup() {
+ }
+ }
+
+ @Test
+ public void testCreatingDescription() throws Exception {
+ final String expectedTable = "<table class=\"table
table-bordered\">" +
+ "<thead>" +
+ "<tr>" +
+ "<th class=\"text-left\" style=\"width:
20%\">Name</th>" +
--- End diff --
This column probably should be named "key".
> Generation HTML from ConfigOption
> ---------------------------------
>
> Key: FLINK-5781
> URL: https://issues.apache.org/jira/browse/FLINK-5781
> Project: Flink
> Issue Type: Sub-task
> Components: Documentation
> Reporter: Ufuk Celebi
> Assignee: Dawid Wysakowicz
>
> Use the ConfigOption instances to generate a HTML page that we can use to
> include in the docs configuration page.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
