Skip to content

Commit 3a57b2b

Browse files
committed
Add missing JavaDoc
1 parent 9d6bcfa commit 3a57b2b

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

log4j/src/main/java/io/fabric8/kubernetes/log4j/lookup/KubernetesLookup.java

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@
4444
/**
4545
* Retrieves various attributes from the Kubernetes server.
4646
* <p>
47-
* Supported keys are:
47+
* The supported keys are listed in the following table:
4848
* </p>
4949
* <table>
50+
* <caption>Supported keys</caption>
5051
* <tr>
5152
* <th>Key</th>
5253
* <th>Description</th>
@@ -166,6 +167,9 @@ public class KubernetesLookup extends AbstractLookup {
166167
private Namespace namespace;
167168
private URL masterUrl;
168169

170+
/**
171+
* Default constructor, called by reflection.
172+
*/
169173
public KubernetesLookup() {
170174
this.pod = null;
171175
this.namespace = null;
@@ -238,7 +242,14 @@ private static void tryInitializeFields(KubernetesLookup lookup) {
238242
}
239243
}
240244

241-
// Used for testing
245+
/**
246+
* Creates a Kubernetes client used to retrieve K8S configuration.
247+
* <p>
248+
* Used in tests to provide a mock client.
249+
* </p>
250+
*
251+
* @return A Kubernetes client.
252+
*/
242253
protected KubernetesClient createClient() {
243254
return ClientBuilder.createClient();
244255
}

log4j/src/main/java/io/fabric8/kubernetes/log4j/lookup/package-info.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,7 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16+
/**
17+
* Provides a lookup to use Kubernetes attributes in a Log4j Core configuration.
18+
*/
1619
package io.fabric8.kubernetes.log4j.lookup;

0 commit comments

Comments
 (0)