From 42fe2f0aca1b8029e15abd198c1084a53e3c2b5a Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Tue, 2 Aug 2016 09:30:05 -0400 Subject: [PATCH] Add docs for a few packages This'll make javadocs slightly more useful.... --- .../java/org/apache/log4j/package-info.java | 23 +++++++++++++++++ .../elasticsearch/action/package-info.java | 23 +++++++++++++++++ .../elasticsearch/monitor/package-info.java | 24 ++++++++++++++++++ .../java/org/elasticsearch/package-info.java | 23 +++++++++++++++++ .../elasticsearch/plugins/package-info.java | 24 ++++++++++++++++++ .../repositories/package-info.java | 23 +++++++++++++++++ .../elasticsearch/script/package-info.java | 25 +++++++++++++++++++ .../search/aggregations/package-info.java | 23 +++++++++++++++++ .../profile/aggregation/package-info.java | 23 +++++++++++++++++ .../search/profile/package-info.java | 23 +++++++++++++++++ .../search/profile/query/package-info.java | 23 +++++++++++++++++ 11 files changed, 257 insertions(+) create mode 100644 core/src/main/java/org/apache/log4j/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/action/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/monitor/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/plugins/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/repositories/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/script/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/search/aggregations/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/search/profile/aggregation/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/search/profile/package-info.java create mode 100644 core/src/main/java/org/elasticsearch/search/profile/query/package-info.java diff --git a/core/src/main/java/org/apache/log4j/package-info.java b/core/src/main/java/org/apache/log4j/package-info.java new file mode 100644 index 00000000000..f628016aa6d --- /dev/null +++ b/core/src/main/java/org/apache/log4j/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. + */ + +/** + * Hack to fix Log4j 1.2 in Java 9. + */ +package org.apache.log4j; diff --git a/core/src/main/java/org/elasticsearch/action/package-info.java b/core/src/main/java/org/elasticsearch/action/package-info.java new file mode 100644 index 00000000000..eb9ebea126d --- /dev/null +++ b/core/src/main/java/org/elasticsearch/action/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. + */ + +/** + * Actions that Elasticsearch can take either on the data stored on disk or on other nodes. + */ +package org.elasticsearch.action; diff --git a/core/src/main/java/org/elasticsearch/monitor/package-info.java b/core/src/main/java/org/elasticsearch/monitor/package-info.java new file mode 100644 index 00000000000..bcfb4ce1f49 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/monitor/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. + */ + +/** + * Monitors the Elasticsearch process and the system on which it is running so that metrics can be exposed via a HTTP or transport APIs to + * be logged and graphed. + */ +package org.elasticsearch.monitor; diff --git a/core/src/main/java/org/elasticsearch/package-info.java b/core/src/main/java/org/elasticsearch/package-info.java new file mode 100644 index 00000000000..de7dfceab36 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/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. + */ + +/** + * A distributed RESTful search engine. + */ +package org.elasticsearch; diff --git a/core/src/main/java/org/elasticsearch/plugins/package-info.java b/core/src/main/java/org/elasticsearch/plugins/package-info.java new file mode 100644 index 00000000000..a6ade87b3b5 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/plugins/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. + */ + +/** + * Support for extending Elasticsearch by providing java code that is loaded by a child classloader. See + * {@link org.elasticsearch.plugins.Plugin}. + */ +package org.elasticsearch.plugins; diff --git a/core/src/main/java/org/elasticsearch/repositories/package-info.java b/core/src/main/java/org/elasticsearch/repositories/package-info.java new file mode 100644 index 00000000000..e068c3fbea1 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/repositories/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. + */ + +/** + * Repositories of snapshot/restore information. + */ +package org.elasticsearch.repositories; diff --git a/core/src/main/java/org/elasticsearch/script/package-info.java b/core/src/main/java/org/elasticsearch/script/package-info.java new file mode 100644 index 00000000000..7ea85693cd3 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/script/package-info.java @@ -0,0 +1,25 @@ +/* + * 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. + */ + +/** + * Support for running user provided scripts (in the request, in cluster state, etc) in portions of various requests + * ({@link org.elasticsearch.common.lucene.search.function.FunctionScoreQuery}, {@link org.elasticsearch.search.aggregations.Aggregation}, + * {@link org.elasticsearch.action.update.UpdateAction}, etc). Pluggable via implementing {@link org.elasticsearch.plugins.ScriptPlugin}. + */ +package org.elasticsearch.script; diff --git a/core/src/main/java/org/elasticsearch/search/aggregations/package-info.java b/core/src/main/java/org/elasticsearch/search/aggregations/package-info.java new file mode 100644 index 00000000000..8a9c199d2e9 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/search/aggregations/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. + */ + +/** + * Builds analytic information over all hits in a search request. + */ +package org.elasticsearch.search.aggregations; diff --git a/core/src/main/java/org/elasticsearch/search/profile/aggregation/package-info.java b/core/src/main/java/org/elasticsearch/search/profile/aggregation/package-info.java new file mode 100644 index 00000000000..f23ba651d10 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/search/profile/aggregation/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. + */ + +/** + * Profiles the aggregation portion of a search request. + */ +package org.elasticsearch.search.profile.aggregation; diff --git a/core/src/main/java/org/elasticsearch/search/profile/package-info.java b/core/src/main/java/org/elasticsearch/search/profile/package-info.java new file mode 100644 index 00000000000..5bf2fa10ac5 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/search/profile/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. + */ + +/** + * Profiling for portions of the search request. + */ +package org.elasticsearch.search.profile; diff --git a/core/src/main/java/org/elasticsearch/search/profile/query/package-info.java b/core/src/main/java/org/elasticsearch/search/profile/query/package-info.java new file mode 100644 index 00000000000..0e999f54570 --- /dev/null +++ b/core/src/main/java/org/elasticsearch/search/profile/query/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. + */ + +/** + * Profiles the query portion of a search request. + */ +package org.elasticsearch.search.profile.query;