You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by gg...@apache.org on 2023/03/20 19:36:14 UTC
[mina-vysper] branch master updated: Javadoc: Port package.html to package-info.java
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-vysper.git
The following commit(s) were added to refs/heads/master by this push:
new 3ba87871 Javadoc: Port package.html to package-info.java
3ba87871 is described below
commit 3ba8787117f639481cf551b30f4732a4231cfa38
Author: Gary Gregory <gg...@rocketsoftware.com>
AuthorDate: Mon Mar 20 15:36:10 2023 -0400
Javadoc: Port package.html to package-info.java
- Fix spelling
---
.../vysper/xmpp/cryptography/package-info.java | 24 ++++++++++++
.../apache/vysper/xmpp/cryptography/package.html | 24 ------------
.../apache/vysper/xmpp/modules/package-info.java | 41 +++++++++++++++++++++
.../org/apache/vysper/xmpp/modules/package.html | 37 -------------------
.../apache/vysper/xmpp/parser/package-info.java | 24 ++++++++++++
.../org/apache/vysper/xmpp/parser/package.html | 24 ------------
.../apache/vysper/xmpp/protocol/package-info.java | 43 ++++++++++++++++++++++
.../org/apache/vysper/xmpp/protocol/package.html | 40 --------------------
.../vysper/xmpp/stanza/dataforms/package-info.java | 24 ++++++++++++
.../vysper/xmpp/stanza/dataforms/package.html | 24 ------------
.../apache/vysper/xmpp/stanza/package-info.java | 25 +++++++++++++
.../org/apache/vysper/xmpp/stanza/package.html | 25 -------------
12 files changed, 181 insertions(+), 174 deletions(-)
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/cryptography/package-info.java b/server/core/src/main/java/org/apache/vysper/xmpp/cryptography/package-info.java
new file mode 100644
index 00000000..14692231
--- /dev/null
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/cryptography/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * Handles everything TLS/SSL related, including certificates.
+ */
+package org.apache.vysper.xmpp.cryptography;
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/cryptography/package.html b/server/core/src/main/java/org/apache/vysper/xmpp/cryptography/package.html
deleted file mode 100644
index c3e8d76b..00000000
--- a/server/core/src/main/java/org/apache/vysper/xmpp/cryptography/package.html
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- 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.
--->
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-</head>
-<body>
-handles everything TLS/SSL related, including certificates
-</body>
-</html>
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/modules/package-info.java b/server/core/src/main/java/org/apache/vysper/xmpp/modules/package-info.java
new file mode 100644
index 00000000..2d1bafc0
--- /dev/null
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/modules/package-info.java
@@ -0,0 +1,41 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * Every module implements a small portion of the core XMPP spec or one of its extensions.
+ * <p>
+ * These implementations come in the shape of {@link org.apache.vysper.xmpp.protocol.StanzaHandler}s where a module
+ * contains all handlers for one (or two) XMPP namespaces. In addition to handlers, a module covers all the
+ * backend functionality needed for the implementation and publishes services (via {@link org.apache.vysper.xmpp.modules.ServerRuntimeContextService})
+ * to be used by others.
+ * </p>
+ * <p>
+ * Many XMPP extensions link into service discovery (XEP-0030). Those modules extend {@link org.apache.vysper.xmpp.modules.DefaultDiscoAwareModule}.
+ * </p>
+ * <p>
+ * The roster module ({@link org.apache.vysper.xmpp.modules.roster})is a simple example.
+ * It installs the {@link org.apache.vysper.xmpp.modules.roster.RosterDictionary}, which registers
+ * {@link org.apache.vysper.xmpp.modules.roster.handler.RosterIQHandler} for the "jabber:iq:roster" namespace. Additionally, it
+ * publishes a {@link org.apache.vysper.xmpp.modules.roster.persistence.RosterManager} implementation, responsible for storing and retrieving
+ * a user's roster. The RosterManager service, which can be accessed through {@link org.apache.vysper.xmpp.server.ServerRuntimeContext#getServerRuntimeContextService},
+ * is also used by the {@link org.apache.vysper.xmpp.modules.core.im.handler.PresenceHandler}.
+ * </p>
+ */
+package org.apache.vysper.xmpp.modules;
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/modules/package.html b/server/core/src/main/java/org/apache/vysper/xmpp/modules/package.html
deleted file mode 100644
index 8ff1b074..00000000
--- a/server/core/src/main/java/org/apache/vysper/xmpp/modules/package.html
+++ /dev/null
@@ -1,37 +0,0 @@
-<!--
- 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.
--->
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-</head>
-<body>
-Every module implements a small portion of the core XMPP spec or one of its extensions.
-These implementations come in the shape of {@link org.apache.vysper.xmpp.protocol.StanzaHandler}s where a module
-contains all handlers for one (or two) XMPP namespaces. In addition to handlers, a module covers all the
-backend functionality needed for the implementation and publishes services (via {@link org.apache.vysper.xmpp.modules.ServerRuntimeContextService})
-to be used by others.
-<p/>
-Many XMPP extensions link into service discovery (XEP-0030). Those modules extend {@link org.apache.vysper.xmpp.modules.DefaultDiscoAwareModule}.
-<p/>
-The roster module ({@link org.apache.vysper.xmpp.modules.roster})is a simple example.
-It installs the {@link org.apache.vysper.xmpp.modules.roster.RosterDictionary}, which registers
-{@link org.apache.vysper.xmpp.modules.roster.handler.RosterIQHandler} for the "jabber:iq:roster" namespace. Additionally, it
-publishes a {@link org.apache.vysper.xmpp.modules.roster.persistence.RosterManager} implementation, responsible for storing and retrieving
-a user's roster. The RosterManager service, which can be accessed through {@link org.apache.vysper.xmpp.server.ServerRuntimeContext#getServerRuntimeContextService},
-is also used by the {@link org.apache.vysper.xmpp.modules.core.im.handler.PresenceHandler}.
-</body>
-</html>
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/parser/package-info.java b/server/core/src/main/java/org/apache/vysper/xmpp/parser/package-info.java
new file mode 100644
index 00000000..d74ab80e
--- /dev/null
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/parser/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * Reads XMPP streams (textual representations) and converts the incoming XML into {@link org.apache.vysper.xmpp.stanza.Stanza} instances.
+ */
+package org.apache.vysper.xmpp.parser;
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/parser/package.html b/server/core/src/main/java/org/apache/vysper/xmpp/parser/package.html
deleted file mode 100644
index 7022b31f..00000000
--- a/server/core/src/main/java/org/apache/vysper/xmpp/parser/package.html
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- 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.
--->
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-</head>
-<body>
-reads XMPP streams (textual representations) and converts the incoming XML into {@link org.apache.vysper.xmpp.stanza.Stanza} instances.
-</body>
-</html>
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/protocol/package-info.java b/server/core/src/main/java/org/apache/vysper/xmpp/protocol/package-info.java
new file mode 100644
index 00000000..d52db4e3
--- /dev/null
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/protocol/package-info.java
@@ -0,0 +1,43 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * The protocol layer is the central place for handling the fundamental logic and assertions of XMPP stanzas going over a XMPP transport.
+ * <p>
+ * The protocol layer normally gets fed from the transport layer, but is independent from it (to be easily testable and
+ * keeping transports pluggable).
+ * </p>
+ * <p>
+ * To execute actual command functionality, the protocol layer looks up (using {@link org.apache.vysper.xmpp.protocol.StanzaHandlerLookup})
+ * and hands over control to the appropriate {@link org.apache.vysper.xmpp.protocol.StanzaHandler}.
+ * It acts as a state machine for a {@link org.apache.vysper.xmpp.server.SessionContext}.
+ * </p>
+ * <p>
+ * Essentially, the protocol layer ensures that every XMPP session is in a well-defined state, the fundamental rules of stanza processing are
+ * followed, that the appropriate handlers are called and session, transport and connection are working well together.
+ * It knows what to do when a session gets closed (unexpectedly or expectedly) and handles stream level errors.
+ * </p>
+ * @see org.apache.vysper.xmpp.protocol.ProtocolWorker
+ * @see org.apache.vysper.xmpp.stanza.Stanza
+ * @see org.apache.vysper.xmpp.protocol.StanzaHandlerLookup
+ * @see org.apache.vysper.xmpp.protocol.StanzaHandler
+ * @see org.apache.vysper.xmpp.protocol.StateAwareProtocolWorker
+ */
+package org.apache.vysper.xmpp.protocol;
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/protocol/package.html b/server/core/src/main/java/org/apache/vysper/xmpp/protocol/package.html
deleted file mode 100644
index 77ee1059..00000000
--- a/server/core/src/main/java/org/apache/vysper/xmpp/protocol/package.html
+++ /dev/null
@@ -1,40 +0,0 @@
-<!--
- 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.
--->
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-</head>
-<body>
-The protocol layer is the central place for handling the fundamental logic and assertions of XMPP stanzas going over a XMPP transport.
-The protocol layer normally gets fed from the transport layer, but is independent from it (to be easily testable and
-keeping transports pluggable).
-<p/>
-To execute actual command functionality, the protocol layer looks up (using {@link org.apache.vysper.xmpp.protocol.StanzaHandlerLookup})
-and hands over control to the appropriate {@link org.apache.vysper.xmpp.protocol.StanzaHandler}.
-It acts as a state machine for a {@link org.apache.vysper.xmpp.server.SessionContext}.
-<p/>
-Essentially, the protocol layer ensures that every XMPP session is in a well-defined state, the fundamental rules of stanza processing are
-followed, that the appropriate handlers are called and session, transport and connection are working well together.
-It knows what to do when a session gets closed (unexectedly or expectedly) and handles stream level errors.
-
-@see org.apache.vysper.xmpp.protocol.ProtocolWorker
-@see org.apache.vysper.xmpp.stanza.Stanza
-@see org.apache.vysper.xmpp.protocol.StanzaHandlerLookup
-@see org.apache.vysper.xmpp.protocol.StanzaHandler
-@see org.apache.vysper.xmpp.protocol.StateAwareProtocolWorker
-</body>
-</html>
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/dataforms/package-info.java b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/dataforms/package-info.java
new file mode 100644
index 00000000..bcbcc58c
--- /dev/null
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/dataforms/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * This package provides support for XEP-0004: Data Forms, see http://xmpp.org/extensions/xep-0004.html.
+ */
+package org.apache.vysper.xmpp.stanza.dataforms;
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/dataforms/package.html b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/dataforms/package.html
deleted file mode 100644
index b9cc2a6c..00000000
--- a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/dataforms/package.html
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- 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.
--->
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-</head>
-<body>
-This package provides support for XEP-0004: Data Forms, see http://xmpp.org/extensions/xep-0004.html .
-</body>
-</html>
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/package-info.java b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/package-info.java
new file mode 100644
index 00000000..ada48bd8
--- /dev/null
+++ b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/package-info.java
@@ -0,0 +1,25 @@
+/*
+ * 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.
+ *
+ */
+
+/**
+ * A {@link org.apache.vysper.xmpp.stanza.Stanza} is an atomic command in XMPP and one fundamental structure
+ * the protocol layer {@link org.apache.vysper.xmpp.protocol} of Vysper uses.
+ */
+package org.apache.vysper.xmpp.stanza;
diff --git a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/package.html b/server/core/src/main/java/org/apache/vysper/xmpp/stanza/package.html
deleted file mode 100644
index 1e8ffaf4..00000000
--- a/server/core/src/main/java/org/apache/vysper/xmpp/stanza/package.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<!--
- 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.
--->
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-</head>
-<body>
-A {@link org.apache.vysper.xmpp.stanza.Stanza} is an atomic command in XMPP and one fundamental structure
-the protocol layer {@link org.apache.vysper.xmpp.protocol} of Vysper uses.
-</body>
-</html>