[Idrs-commit] CVS: Idrs/dev/docs/net/sourceforge/idrs/deploy/macro MacroToXML.html,1.1,1.2 MacroToXM
Brought to you by:
bigman921
Menu
▾
▴
[Idrs-commit] CVS: Idrs/dev/docs/net/sourceforge/idrs/deploy/macro MacroToXML.html,1.1,1.2 MacroToXMLHandler.html,1.1,1.2 Tag.html,1.1,1.2 package-frame.html,1.1,1.2 package-summary.html,1.1,1.2 package-tree.html,1.1,1.2
Update of /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro
In directory usw-pr-cvs1:/tmp/cvs-serv12624/net/sourceforge/idrs/deploy/macro
Modified Files:
MacroToXML.html MacroToXMLHandler.html Tag.html
package-frame.html package-summary.html package-tree.html
Log Message:
Added java docs to classes in net.sourceforge.idrs.deploy.macro package
Index: MacroToXML.html
===================================================================
RCS file: /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro/MacroToXML.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** MacroToXML.html 2002/01/23 14:07:39 1.1
--- MacroToXML.html 2002/01/23 19:49:52 1.2
***************
*** 3,7 ****
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 08:59:32 EST 2002 -->
<TITLE>
: Class MacroToXML
--- 3,7 ----
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 14:49:13 EST 2002 -->
<TITLE>
: Class MacroToXML
***************
*** 68,71 ****
--- 68,73 ----
<P>
+ Performs parsing of RML-macro pages and transforms the rml pages into RML-XML pages
+ <P>
<HR>
***************
*** 202,206 ****
<BR>
! </TD>
</TR>
</TABLE>
--- 204,208 ----
<BR>
! Constructor, loads transoformation xml document</TD>
</TR>
</TABLE>
***************
*** 220,224 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 222,226 ----
<BR>
! Determines if a tag is an RML tag</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 228,232 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 230,234 ----
<BR>
! Determines if current tag is a script tag</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 236,240 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 238,242 ----
<BR>
! Writes a fully xml compatable version of a script</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 244,248 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 246,250 ----
<BR>
! Writes the RML tag as full XML 1.0 tag</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 252,256 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 254,258 ----
<BR>
! Writes text apropriatly, either with text tags or without them</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 260,264 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 262,266 ----
<BR>
! Reads rmlSrc for position of the end of the current tag</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 268,272 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 270,274 ----
<BR>
! Sets the rml-macro source as a string</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 276,280 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 278,282 ----
<BR>
! Sets the writer where the RML-XML will be written to</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 284,288 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 286,290 ----
<BR>
! Determines if the current block of text should be wrapped in text tags</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 292,296 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 294,298 ----
<BR>
! Transforms the RML-Macro page into an RML-XML page</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 300,304 ****
<BR>
! </TD>
</TR>
</TABLE>
--- 302,306 ----
<BR>
! Returns an XML escaped version of the text passed it</TD>
</TR>
</TABLE>
***************
*** 446,449 ****
--- 448,454 ----
throws java.lang.Exception</PRE>
<DL>
+ <DD>Constructor, loads transoformation xml document<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>parser</CODE> - Class of parser to be used to parse XML transformation document<DD><CODE>xmlSrc</CODE> - Source of XML document, either a string or a file path<DD><CODE>isFile</CODE> - Identifies if xmlSrc is the xml as a string or a path to the xml file</DL>
+ </DD>
</DL>
***************
*** 463,466 ****
--- 468,474 ----
public void <B>setRML</B>(java.lang.String rml)</PRE>
<DL>
+ <DD>Sets the rml-macro source as a string<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>rml</CODE> - The RML-Macro source</DL>
+ </DD>
</DL>
<HR>
***************
*** 472,475 ****
--- 480,486 ----
throws java.io.IOException</PRE>
<DL>
+ <DD>Sets the writer where the RML-XML will be written to<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>out</CODE> - Writer for output</DL>
+ </DD>
</DL>
<HR>
***************
*** 481,485 ****
throws java.io.IOException</PRE>
<DL>
! </DL>
<HR>
--- 492,496 ----
throws java.io.IOException</PRE>
<DL>
! <DD>Transforms the RML-Macro page into an RML-XML page</DL>
<HR>
***************
*** 489,492 ****
--- 500,506 ----
protected boolean <B>isScriptTag</B>(int begin)</PRE>
<DL>
+ <DD>Determines if current tag is a script tag<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>begin</CODE> - Begining of tag in rmlSrc</DL>
+ </DD>
</DL>
<HR>
***************
*** 498,501 ****
--- 512,518 ----
throws java.io.IOException</PRE>
<DL>
+ <DD>Writes a fully xml compatable version of a script<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>begin</CODE> - Beginning of tag in rmlSrc</DL>
+ </DD>
</DL>
<HR>
***************
*** 507,510 ****
--- 524,530 ----
throws java.io.IOException</PRE>
<DL>
+ <DD>Writes text apropriatly, either with text tags or without them<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>txt</CODE> - Text to be written</DL>
+ </DD>
</DL>
<HR>
***************
*** 515,518 ****
--- 535,541 ----
protected int <B>readTag</B>(int begin)</PRE>
<DL>
+ <DD>Reads rmlSrc for position of the end of the current tag<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>begin</CODE> - Beginning of tag in rmlSrc</DL>
+ </DD>
</DL>
<HR>
***************
*** 523,526 ****
--- 546,552 ----
protected boolean <B>isRMLTag</B>(java.lang.String tag)</PRE>
<DL>
+ <DD>Determines if a tag is an RML tag<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>tag</CODE> - Tag to check</DL>
+ </DD>
</DL>
<HR>
***************
*** 532,535 ****
--- 558,564 ----
throws java.io.IOException</PRE>
<DL>
+ <DD>Writes the RML tag as full XML 1.0 tag<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>tag</CODE> - Tag to write</DL>
+ </DD>
</DL>
<HR>
***************
*** 540,544 ****
protected boolean <B>shouldWrite</B>()</PRE>
<DL>
! </DL>
<HR>
--- 569,573 ----
protected boolean <B>shouldWrite</B>()</PRE>
<DL>
! <DD>Determines if the current block of text should be wrapped in text tags</DL>
<HR>
***************
*** 548,551 ****
--- 577,583 ----
protected java.lang.String <B>xmlEncode</B>(java.lang.String txt)</PRE>
<DL>
+ <DD>Returns an XML escaped version of the text passed it<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>txt</CODE> - Text to encode</DL>
+ </DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
Index: MacroToXMLHandler.html
===================================================================
RCS file: /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro/MacroToXMLHandler.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** MacroToXMLHandler.html 2002/01/23 14:07:39 1.1
--- MacroToXMLHandler.html 2002/01/23 19:49:52 1.2
***************
*** 3,7 ****
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 08:59:32 EST 2002 -->
<TITLE>
: Class MacroToXMLHandler
--- 3,7 ----
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 14:49:13 EST 2002 -->
<TITLE>
: Class MacroToXMLHandler
***************
*** 66,69 ****
--- 66,71 ----
<P>
+ Used to parse out the transformation xml document and suply information obout that document
+ <P>
<HR>
***************
*** 292,296 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 294,298 ----
<BR>
! Returns the case-sensitive version of the rml tag for use in final xml document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 300,304 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 302,306 ----
<BR>
! Returns the tag used for echo scripts, <$= $></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 308,312 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 310,314 ----
<BR>
! Returns the rml name space used for full XML tags specified in the transformation document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 316,320 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 318,323 ----
<BR>
! Retrieves the character identified by the transformation document as the script character,
! the default is $ for <$ $>, <$= $></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 324,328 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 327,331 ----
<BR>
! Returns the tag specified in the transformation document that will be used for scripts</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 332,336 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 335,339 ----
<BR>
! Returns the tag that will identify plain text</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 340,360 ****
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
! <TD><CODE><B><A HREF="../../../../../net/sourceforge/idrs/deploy/macro/MacroToXMLHandler.html#isTagSimple(java.lang.String)">isTagSimple</A></B>(java.lang.String tag)</CODE>
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
! <TD><CODE><B><A HREF="../../../../../net/sourceforge/idrs/deploy/macro/MacroToXMLHandler.html#isTagWonLine(java.lang.String)">isTagWonLine</A></B>(java.lang.String tag)</CODE>
<BR>
! </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
--- 343,363 ----
<BR>
! Returns wether or not a suplied tag is rml</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
! <TD><CODE><B><A HREF="../../../../../net/sourceforge/idrs/deploy/macro/MacroToXMLHandler.html#isTagOwnLine(java.lang.String)">isTagOwnLine</A></B>(java.lang.String tag)</CODE>
<BR>
! Determines if a tag must apear on it's own line</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
! <TD><CODE><B><A HREF="../../../../../net/sourceforge/idrs/deploy/macro/MacroToXMLHandler.html#isTagSimple(java.lang.String)">isTagSimple</A></B>(java.lang.String tag)</CODE>
<BR>
! Determines if a tag contains only one type of content, wether tags only or text only</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
***************
*** 625,628 ****
--- 628,635 ----
public char <B>getScriptChar</B>()</PRE>
<DL>
+ <DD>Retrieves the character identified by the transformation document as the script character,
+ the default is $ for <$ $>, <$= $><DD><DL>
+ <DT><B>Returns:</B><DD> </DL>
+ </DD>
</DL>
<HR>
***************
*** 633,637 ****
public java.lang.String <B>getScriptTag</B>()</PRE>
<DL>
! </DL>
<HR>
--- 640,644 ----
public java.lang.String <B>getScriptTag</B>()</PRE>
<DL>
! <DD>Returns the tag specified in the transformation document that will be used for scripts</DL>
<HR>
***************
*** 641,645 ****
public java.lang.String <B>getEchoScriptTag</B>()</PRE>
<DL>
! </DL>
<HR>
--- 648,652 ----
public java.lang.String <B>getEchoScriptTag</B>()</PRE>
<DL>
! <DD>Returns the tag used for echo scripts, <$= $></DL>
<HR>
***************
*** 649,653 ****
public java.lang.String <B>getNameSpace</B>()</PRE>
<DL>
! </DL>
<HR>
--- 656,660 ----
public java.lang.String <B>getNameSpace</B>()</PRE>
<DL>
! <DD>Returns the rml name space used for full XML tags specified in the transformation document</DL>
<HR>
***************
*** 657,661 ****
public java.lang.String <B>getTextTag</B>()</PRE>
<DL>
! </DL>
<HR>
--- 664,668 ----
public java.lang.String <B>getTextTag</B>()</PRE>
<DL>
! <DD>Returns the tag that will identify plain text</DL>
<HR>
***************
*** 665,668 ****
--- 672,678 ----
public boolean <B>isRMLTag</B>(java.lang.String tag)</PRE>
<DL>
+ <DD>Returns wether or not a suplied tag is rml<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>tag</CODE> - Tag being tested</DL>
+ </DD>
</DL>
<HR>
***************
*** 673,676 ****
--- 683,689 ----
public java.lang.String <B>getCorrectRMLTagName</B>(java.lang.String tag)</PRE>
<DL>
+ <DD>Returns the case-sensitive version of the rml tag for use in final xml document<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>tag</CODE> - Tag to be transformed in any case</DL>
+ </DD>
</DL>
<HR>
***************
*** 681,692 ****
public boolean <B>isTagSimple</B>(java.lang.String tag)</PRE>
<DL>
</DL>
<HR>
! <A NAME="isTagWonLine(java.lang.String)"><!-- --></A><H3>
! isTagWonLine</H3>
<PRE>
! public boolean <B>isTagWonLine</B>(java.lang.String tag)</PRE>
<DL>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
--- 694,711 ----
public boolean <B>isTagSimple</B>(java.lang.String tag)</PRE>
<DL>
+ <DD>Determines if a tag contains only one type of content, wether tags only or text only<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>tag</CODE> - Tag to test</DL>
+ </DD>
</DL>
<HR>
! <A NAME="isTagOwnLine(java.lang.String)"><!-- --></A><H3>
! isTagOwnLine</H3>
<PRE>
! public boolean <B>isTagOwnLine</B>(java.lang.String tag)</PRE>
<DL>
+ <DD>Determines if a tag must apear on it's own line<DD><DL>
+ <DT><B>Parameters:</B><DD><CODE>tag</CODE> - Tag to test</DL>
+ </DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
Index: Tag.html
===================================================================
RCS file: /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro/Tag.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** Tag.html 2002/01/23 14:07:39 1.1
--- Tag.html 2002/01/23 19:49:52 1.2
***************
*** 3,7 ****
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 08:59:32 EST 2002 -->
<TITLE>
: Class Tag
--- 3,7 ----
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 14:49:13 EST 2002 -->
<TITLE>
: Class Tag
***************
*** 67,70 ****
--- 67,72 ----
<DT> class <B>Tag</B><DT>extends java.lang.Object</DL>
+ <P>
+ Structure for holding the structure of tags
<P>
<HR>
Index: package-frame.html
===================================================================
RCS file: /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro/package-frame.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** package-frame.html 2002/01/23 14:07:39 1.1
--- package-frame.html 2002/01/23 19:49:52 1.2
***************
*** 3,7 ****
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 08:59:29 EST 2002 -->
<TITLE>
: Package net.sourceforge.idrs.deploy.macro
--- 3,7 ----
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 14:49:11 EST 2002 -->
<TITLE>
: Package net.sourceforge.idrs.deploy.macro
Index: package-summary.html
===================================================================
RCS file: /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro/package-summary.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** package-summary.html 2002/01/23 14:07:39 1.1
--- package-summary.html 2002/01/23 19:49:52 1.2
***************
*** 3,7 ****
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 08:59:29 EST 2002 -->
<TITLE>
: Package net.sourceforge.idrs.deploy.macro
--- 3,7 ----
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 14:49:11 EST 2002 -->
<TITLE>
: Package net.sourceforge.idrs.deploy.macro
***************
*** 57,69 ****
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MacroToXML.html">MacroToXML</A></B></TD>
! <TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MacroToXMLHandler.html">MacroToXMLHandler</A></B></TD>
! <TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="Tag.html">Tag</A></B></TD>
! <TD> </TD>
</TR>
</TABLE>
--- 57,69 ----
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MacroToXML.html">MacroToXML</A></B></TD>
! <TD>Performs parsing of RML-macro pages and transforms the rml pages into RML-XML pages</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="MacroToXMLHandler.html">MacroToXMLHandler</A></B></TD>
! <TD>Used to parse out the transformation xml document and suply information obout that document</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="Tag.html">Tag</A></B></TD>
! <TD>Structure for holding the structure of tags</TD>
</TR>
</TABLE>
Index: package-tree.html
===================================================================
RCS file: /cvsroot/idrs/Idrs/dev/docs/net/sourceforge/idrs/deploy/macro/package-tree.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** package-tree.html 2002/01/23 14:07:39 1.1
--- package-tree.html 2002/01/23 19:49:52 1.2
***************
*** 3,7 ****
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 08:59:29 EST 2002 -->
<TITLE>
: net.sourceforge.idrs.deploy.macro Class Hierarchy
--- 3,7 ----
<HTML>
<HEAD>
! <!-- Generated by javadoc on Wed Jan 23 14:49:11 EST 2002 -->
<TITLE>
: net.sourceforge.idrs.deploy.macro Class Hierarchy
|
