From e2da6a8ee58ab8ec2fe464477b9a44f8b0b5dca4 Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Thu, 19 Jan 2017 11:04:08 -0500 Subject: [PATCH] Improve painless's javadocs Hopefully useful references. --- .../painless/antlr/package-info.java | 24 +++++++++++++++++++ .../elasticsearch/painless/package-info.java | 23 ++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 modules/lang-painless/src/main/java/org/elasticsearch/painless/antlr/package-info.java create mode 100644 modules/lang-painless/src/main/java/org/elasticsearch/painless/package-info.java diff --git a/modules/lang-painless/src/main/java/org/elasticsearch/painless/antlr/package-info.java b/modules/lang-painless/src/main/java/org/elasticsearch/painless/antlr/package-info.java new file mode 100644 index 00000000000..041118ba029 --- /dev/null +++ b/modules/lang-painless/src/main/java/org/elasticsearch/painless/antlr/package-info.java @@ -0,0 +1,24 @@ +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch 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. + */ + +/** + * Lexer, parser, and tree {@link Walker} responsible for turning the code + * generating nodes in {@link org.elasticsearch.painless.node}. + */ +package org.elasticsearch.painless.antlr; diff --git a/modules/lang-painless/src/main/java/org/elasticsearch/painless/package-info.java b/modules/lang-painless/src/main/java/org/elasticsearch/painless/package-info.java new file mode 100644 index 00000000000..d45d4fb6d49 --- /dev/null +++ b/modules/lang-painless/src/main/java/org/elasticsearch/painless/package-info.java @@ -0,0 +1,23 @@ +/* + * Licensed to Elasticsearch under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch 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. + */ + +/** + * Implementation of the Painless language. + */ +package org.elasticsearch.painless;