1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-18 17:01:08 +01:00

Enable werror for javadoc and fix javadoc issues

This commit is contained in:
Florian Schmaus 2019-08-30 12:08:30 +02:00
parent 4249c1a845
commit 1a3067c89b
323 changed files with 2929 additions and 2704 deletions

View file

@ -491,6 +491,7 @@ public final class FormField implements FullyQualifiedElement {
* Sets an indicative of the format for the data to answer.
*
* @param type an indicative of the format for the data to answer.
* @return a reference to this builder.
* @see Type
*/
public Builder setType(Type type) {
@ -517,6 +518,7 @@ public final class FormField implements FullyQualifiedElement {
* </p>
*
* @param description provides extra clarification about the question.
* @return a reference to this builder.
*/
public Builder setDescription(String description) {
Description descriptionElement = new Description(description);
@ -529,6 +531,7 @@ public final class FormField implements FullyQualifiedElement {
* fill out the form.
*
* @param label the label of the question.
* @return a reference to this builder.
*/
public Builder setLabel(String label) {
this.label = label;
@ -539,6 +542,7 @@ public final class FormField implements FullyQualifiedElement {
* Sets if the question must be answered in order to complete the questionnaire.
*
* @param required if the question must be answered in order to complete the questionnaire.
* @return a reference to this builder.
*/
public Builder setRequired(boolean required) {
setOnlyElement(Required.INSTANCE, Required.class);
@ -550,6 +554,7 @@ public final class FormField implements FullyQualifiedElement {
* Otherwise, adds an answered value to the question.
*
* @param value a default value or an answered value of the question.
* @return a reference to this builder.
*/
public Builder addValue(CharSequence value) {
return addFormFieldChildElement(new Value(value));
@ -560,6 +565,7 @@ public final class FormField implements FullyQualifiedElement {
* instance was formated.
*
* @param date the date instance to add as XEP-0082 formated string.
* @return a reference to this builder.
*/
public Builder addValue(Date date) {
String dateString = XmppDateTime.formatXEP0082Date(date);
@ -571,6 +577,7 @@ public final class FormField implements FullyQualifiedElement {
* Otherwise, adds an answered values to the question.
*
* @param values default values or an answered values of the question.
* @return a reference to this builder.
*/
public Builder addValues(Collection<? extends CharSequence> values) {
for (CharSequence value : values) {
@ -588,6 +595,7 @@ public final class FormField implements FullyQualifiedElement {
* the question.
*
* @param option a new available option for the question.
* @return a reference to this builder.
*/
public Builder addOption(Option option) {
return addFormFieldChildElement(option);

View file

@ -88,10 +88,10 @@ public final class XDataManager extends Manager {
*
* @param jid the JID of the entity to check.
* @return true if the entity supports data forms.
* @throws NoResponseException
* @throws XMPPErrorException
* @throws NotConnectedException
* @throws InterruptedException
* @throws NoResponseException if there was no response from the remote entity.
* @throws XMPPErrorException if there was an XMPP error returned.
* @throws NotConnectedException if the XMPP connection is not connected.
* @throws InterruptedException if the calling thread was interrupted.
* @see <a href="http://xmpp.org/extensions/xep-0004.html#disco">XEP-0004: Data Forms § 6. Service Discovery</a>
* @since 4.1
*/

View file

@ -151,7 +151,7 @@ public class DataForm implements ExtensionElement {
/**
* Return the form field with the given variable name or null.
*
* @param variableName
* @param variableName TODO javadoc me please
* @return the form field or null.
* @since 4.1
*/
@ -175,7 +175,7 @@ public class DataForm implements ExtensionElement {
/**
* Check if a form field with the given variable name exists.
*
* @param variableName
* @param variableName TODO javadoc me please
* @return true if a form field with the variable name exists, false otherwise.
* @since 4.2
*/
@ -250,7 +250,7 @@ public class DataForm implements ExtensionElement {
/**
* Add the given fields to this form.
*
* @param fieldsToAdd
* @param fieldsToAdd TODO javadoc me please
* @return true if a field was overridden.
* @since 4.3.0
*/
@ -357,7 +357,7 @@ public class DataForm implements ExtensionElement {
/**
* Get data form from stanza.
* @param packet
* @param packet TODO javadoc me please
* @return the DataForm or null
*/
public static DataForm from(Stanza packet) {