1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-14 15:01:07 +01:00

Fix javadoc issues in some packages

This commit is contained in:
Paul Schaub 2017-12-23 20:21:19 +01:00
parent cb18056613
commit 52398b535f
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
50 changed files with 255 additions and 56 deletions

View file

@ -51,6 +51,7 @@ public class XHTMLText {
*
* @param href indicates the URL being linked to
* @param style the XHTML style of the anchor
* @return this.
*/
public XHTMLText appendOpenAnchorTag(String href, String style) {
text.halfOpenElement(A);
@ -62,7 +63,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that an anchor section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseAnchorTag() {
text.closeElement(A);
@ -74,6 +76,7 @@ public class XHTMLText {
* Appends a tag that indicates that a blockquote section begins.
*
* @param style the XHTML style of the blockquote
* @return this.
*/
public XHTMLText appendOpenBlockQuoteTag(String style) {
text.halfOpenElement(BLOCKQUOTE);
@ -84,7 +87,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that a blockquote section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseBlockQuoteTag() {
text.closeElement(BLOCKQUOTE);
@ -96,6 +100,7 @@ public class XHTMLText {
*
* @param style the XHTML style of the body
* @param lang the language of the body
* @return this.
*/
private XHTMLText appendOpenBodyTag(String style, String lang) {
text.halfOpenElement(Message.BODY);
@ -106,6 +111,11 @@ public class XHTMLText {
return this;
}
/**
* Appends a tag that indicates that the body section ends.
*
* @return this.
*/
public XHTMLText appendCloseBodyTag() {
text.closeElement(Message.BODY);
return this;
@ -117,7 +127,8 @@ public class XHTMLText {
/**
* Appends a tag that inserts a single carriage return.
*
*
* @return this.
*/
public XHTMLText appendBrTag() {
text.emptyElement(BR);
@ -126,7 +137,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates a reference to work, such as a book, report or web site.
*
*
* @return this.
*/
public XHTMLText appendOpenCiteTag() {
text.openElement(CITE);
@ -135,7 +147,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates text that is the code for a program.
*
*
* @return this.
*/
public XHTMLText appendOpenCodeTag() {
text.openElement(CODE);
@ -144,7 +157,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates end of text that is the code for a program.
*
*
* @return this.
*/
public XHTMLText appendCloseCodeTag() {
text.closeElement(CODE);
@ -155,7 +169,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates emphasis.
*
*
* @return this.
*/
public XHTMLText appendOpenEmTag() {
text.openElement(EM);
@ -164,7 +179,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates end of emphasis.
*
*
* @return this.
*/
public XHTMLText appendCloseEmTag() {
text.closeElement(EM);
@ -178,6 +194,8 @@ public class XHTMLText {
*
* @param level the level of the Header. It must be a value between 1 and 3
* @param style the XHTML style of the blockquote
*
* @return this.
*/
public XHTMLText appendOpenHeaderTag(int level, String style) {
if (level > 3 || level < 1) {
@ -193,6 +211,7 @@ public class XHTMLText {
* Appends a tag that indicates that a header section ends.
*
* @param level the level of the Header. It must be a value between 1 and 3
* @return this.
*/
public XHTMLText appendCloseHeaderTag(int level) {
if (level > 3 || level < 1) {
@ -212,6 +231,8 @@ public class XHTMLText {
* @param height how tall is the picture
* @param src where to get the picture
* @param width how wide is the picture
*
* @return this.
*/
public XHTMLText appendImageTag(String align, String alt, String height, String src, String width) {
text.halfOpenElement(IMG);
@ -231,6 +252,8 @@ public class XHTMLText {
* Appends a tag that indicates the start of a new line item within a list.
*
* @param style the style of the line item
*
* @return this.
*/
public XHTMLText appendLineItemTag(String style) {
text.halfOpenElement(LI);
@ -242,6 +265,7 @@ public class XHTMLText {
/**
* Appends a tag that indicates that a line item section ends.
*
* @return this.
*/
public XHTMLText appendCloseLineItemTag() {
text.closeElement(LI);
@ -253,6 +277,8 @@ public class XHTMLText {
* in the list is important. To show this, browsers automatically number the list.
*
* @param style the style of the ordered list
*
* @return this.
*/
public XHTMLText appendOpenOrderedListTag(String style) {
text.halfOpenElement(OL);
@ -263,7 +289,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that an ordered list section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseOrderedListTag() {
text.closeElement(OL);
@ -277,6 +304,8 @@ public class XHTMLText {
* in the list are not in any particular order.
*
* @param style the style of the unordered list
*
* @return this.
*/
public XHTMLText appendOpenUnorderedListTag(String style) {
text.halfOpenElement(UL);
@ -287,7 +316,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that an unordered list section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseUnorderedListTag() {
text.closeElement(UL);
@ -301,6 +331,8 @@ public class XHTMLText {
* with two carriage returns, producing a single blank line in between the two paragraphs.
*
* @param style the style of the paragraph
*
* @return this.
*/
public XHTMLText appendOpenParagraphTag(String style) {
text.halfOpenElement(P);
@ -312,7 +344,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates the end of a new paragraph. This is usually rendered
* with two carriage returns, producing a single blank line in between the two paragraphs.
*
*
* @return this.
*/
public XHTMLText appendCloseParagraphTag() {
text.closeElement(P);
@ -325,6 +358,8 @@ public class XHTMLText {
* Appends a tag that indicates that an inlined quote section begins.
*
* @param style the style of the inlined quote
*
* @return this.
*/
public XHTMLText appendOpenInlinedQuoteTag(String style) {
text.halfOpenElement(Q);
@ -335,7 +370,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that an inlined quote section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseInlinedQuoteTag() {
text.closeElement(Q);
@ -348,6 +384,8 @@ public class XHTMLText {
* Appends a tag that allows to set the fonts for a span of text.
*
* @param style the style for a span of text
*
* @return this.
*/
public XHTMLText appendOpenSpanTag(String style) {
text.halfOpenElement(SPAN);
@ -358,7 +396,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that a span section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseSpanTag() {
text.closeElement(SPAN);
@ -369,7 +408,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates text which should be more forceful than surrounding text.
*
*
* @return this.
*/
public XHTMLText appendOpenStrongTag() {
text.openElement(STRONG);
@ -378,7 +418,8 @@ public class XHTMLText {
/**
* Appends a tag that indicates that a strong section ends.
*
*
* @return this.
*/
public XHTMLText appendCloseStrongTag() {
text.closeElement(STRONG);
@ -388,7 +429,9 @@ public class XHTMLText {
/**
* Appends a given text to the XHTMLText.
*
* @param textToAppend the text to append
* @param textToAppend the text to append
*
* @return this.
*/
public XHTMLText append(String textToAppend) {
text.escape(textToAppend);