HomeDigital EditionSys-Con RadioSearch Java Cd
Advanced Java AWT Book Reviews/Excerpts Client Server Corba Editorials Embedded Java Enterprise Java IDE's Industry Watch Integration Interviews Java Applet Java & Databases Java & Web Services Java Fundamentals Java Native Interface Java Servlets Java Beans J2ME Libraries .NET Object Orientation Observations/IMHO Product Reviews Scalability & Performance Security Server Side Source Code Straight Talking Swing Threads Using Java with others Wireless XML
 

"Writing XML-Friendly Java Documentation"
Volume: 5 Issue: 1, p.44

	

Listing 1:

<H3>parseInt</H3>
public static int <B>parseInt</B>
(<A HREF="String.html">String</A> s) throws
<A HREF="NumberFormatException.html">
NumberFormatException</A>
<DL>
<DD>
       Parses the string argument as a
       signed decimal integer. The characters
       in the string must all be decimal digits,
       except that the first character may be
       an ASCII minus sign <code>'-'</code>
       (<tt>'\u002d'</tt>) to indicate a
       negative value. The resulting integer
       value is returned, exactly as if the
       argument and the radix 10 were given as
       arguments to the
  <A HREF="Integer.html#parseInt"><CODE>
  parseInt(java.lang.String, int)</CODE>
   </A> method.
   <DD>
        <DL></DL>
  </DD>
     <DD>
    <DL>
       <DT><B>Parameters:</B>
       <DD><CODE>s</CODE> - a string.
       <DT><B>Returns:</B>
       <DD>
         the integer represented by the
         argument in decimal.
         <DT><B>Throws:</B>
         <DD>
          <A HREF="NumberFormatException.html">
          NumberFormatException</A> - if the
          string does not contain a parsable
          integer.
    </DL>
  </DD>
</DL>
<HR>


Listing 2:

<method accessSpecifier="public" static="true">
  <methodName>parseInt</methodName>
  <signature>(String)</signature>
  <return>
    <returnType>int</returnType>
    <returnDescription>
              the integer represented by the
              argument in
     decimal.
    </returnDescription>
  </return>
  <description>
    <briefDescription>
     Parses the string argument as a
    signed decimal integer.
    </briefDescription>
    <fullDescription>
      ...
    </fullDescription>
  </description>
  <parameter>
    <parameterType>
      java.lang.String
    </parameterType>
    <parameterName>s</parameterName>
    <description>
      <briefDescription>
        s - a string.
      </briefDescription>
      <fullDescription>
        s - a string.
      </fullDescription>
    </description>
  </parameter>
  <exception>
    <exceptionType>
      NumberFormatException
    </exceptionType>
    <description>
      <briefDescription>
        NumberFormatException - if the
       string does
        not contain a parsable integer.
      </briefDescription>
      <fullDescription>
        NumberFormatException - if the
       string does
        not contain a parsable integer.
      </fullDescription>
    </description>
  </exception>
</method>


 

All Rights Reserved
Copyright ©  2004 SYS-CON Media, Inc.
  E-mail: [email protected]

Java and Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. SYS-CON Publications, Inc. is independent of Sun Microsystems, Inc.