Changeset 76 in tmcsimulator-scriptbuilder for trunk/src/scriptbuilder/structures/XMLWriter.java


Ignore:
Timestamp:
08/25/2017 12:22:28 PM (9 years ago)
Author:
bmcguffin
Message:

Added javadoc for several files.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/scriptbuilder/structures/XMLWriter.java

    r46 r76  
    88{ 
    99 
     10    /** 
     11     * XML-style opening tag. Example: if given string "my_tag", returns 
     12     * "<my_tag>". 
     13     * 
     14     * @param s the XML element to be included in the tag. 
     15     * @return the properly formatted tag 
     16     */ 
    1017    public static String openTag(String s) 
    1118    { 
    … …  
    1320    } 
    1421 
     22    /** 
     23     * XML-style closing tag. Example: if given string "my_tag", returns 
     24     * "</my_tag>". 
     25     * 
     26     * @param s the XML element to be included in the tag. 
     27     * @return the properly formatted tag 
     28     */ 
    1529    public static String closeTag(String s) 
    1630    { 
    … …  
    1832    } 
    1933 
     34    /** 
     35     * XML-style empty tag. Example: if given string "my_tag", returns 
     36     * "<my_tag/>". 
     37     * 
     38     * @param s the XML element to be included in the tag. 
     39     * @return the properly formatted tag 
     40     */ 
    2041    public static String emptyTag(String s) 
    2142    { 
    … …  
    2344    } 
    2445 
     46    /** 
     47     * Creates a pair of XML open and close tags to wrap a simple line of data. 
     48     * Useful if only one element need be enclosed in this particular tag. 
     49     * 
     50     * @param s the data to be wrapped 
     51     * @param e the XML element represented by the data 
     52     * @return an XML string of the format <my_tag>some_data_goes_here</my_tag> 
     53     */ 
    2554    public static String simpleTag(String s, ELEMENT e) 
    2655    { 
Note: See TracChangeset for help on using the changeset viewer.