foray-commit Mailing List for FOray

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 9056
          http://svn.sourceforge.net/foray/?rev=9056&view=rev
Author:   victormote
Date:     2007-03-30 18:28:52 -0700 (Fri, 30 Mar 2007)

Log Message:
-----------
Javadoc improvements.

Modified Paths:
--------------
    trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineNonText.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineText.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/FOTreeBuilder.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjMixed.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjScaled.java
    trunk/foray/foray-fotree/src/java/org/foray/fotree/ForeignXML.java

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineNonText.java
===================================================================

--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineNonText.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineNonText.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -37,9 +37,17 @@
  */
 public class FOLineNonText implements org.axsl.foR.FOLineNonText {
 
+    /** The wrapped non-text item. */
     private org.axsl.foR.FOLineNonText realLineNonText;
+
+    /** The FO context for this non-text item. */
     private FOContext context;
 
+    /**
+     * Constructor.
+     * @param realLineNonText The wrapped non-text item.
+     * @param context The FO context for this non-text item.
+     */
     public FOLineNonText(final org.axsl.foR.FOLineNonText realLineNonText,
             final FOContext context) {
         this.realLineNonText = realLineNonText;

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineText.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineText.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FOLineText.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -39,9 +39,17 @@
  */
 public class FOLineText implements org.axsl.foR.FOLineText {
 
+    /** The wrapped text item. */
     private org.axsl.foR.FOLineText realLineText;
+
+    /** The FO context for this text item. */
     private FOContext context;
 
+    /**
+     * Constructor.
+     * @param realLineText The wrapped text item.
+     * @param context The FO context for this text item.
+     */
     public FOLineText(final org.axsl.foR.FOLineText realLineText,
             final FOContext context) {
         this.realLineText = realLineText;

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FONode.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -104,6 +104,12 @@
         return getParent();
     }
 
+    /**
+     * Returns the effective parent of a Marker instance.
+     * @param context An object that knows how to resolve FO Tree context
+     * issues.
+     * @return The parent of the RetrieveMarker instance found in the context.
+     */
     private FObj effectiveMarkerParent(final FOContext context) {
         if (context == null) {
             /* TODO: Consider throwing an Exception. This should NOT
@@ -152,6 +158,14 @@
                 this.getColumn());
     }
 
+    /**
+     * Creates a context message from a given set of Locator information, which
+     * is useful in user messages.
+     * @param systemId The path to the document.
+     * @param line The line number in systemId.
+     * @param column The column number in line.
+     * @return A String describing the location specified.
+     */
     public String getContextMessage(final String systemId, final int line,
             final int column) {
         return "  Context: " + systemId + "\n"
@@ -172,18 +186,37 @@
         return parent.ancestorMarker();
     }
 
+    /**
+     * Return the ancestor tree builder.
+     * @return The ancestor tree builder.
+     */
     public FOTreeBuilder getFOTreeBuilder() {
         return getParent().getFOTreeBuilder();
     }
 
+    /**
+     * Return the logger.
+     * @return The logger.
+     */
     public Log getLogger() {
         return getParent().getLogger();
     }
 
+    /**
+     * Convenience method handling some details of throwing a parsing exception.
+     * @param message The message indicating the reason for the exception.
+     * @throws FOTreeException Always, as that is the purpose of this method.
+     */
     public void throwException(final String message) throws FOTreeException {
         throwException(getContextMessage(), message);
     }
 
+    /**
+     * Convenience method handling some details of throwing a parsing exception.
+     * @param contextMessage The context portion of the exception message.
+     * @param message The message indicating the reason for the exception.
+     * @throws FOTreeException Always, as that is the purpose of this method.
+     */
     public void throwException(final String contextMessage,
             final String message) throws FOTreeException {
         final FOTreeException exception = new FOTreeException(message);

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FOTreeBuilder.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FOTreeBuilder.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FOTreeBuilder.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -269,19 +269,33 @@
         throw new SAXException(new FOTreeException(fote));
     }
 
+    /**
+     * Reset this parser for reuse.
+     */
     public void reset() {
         currentFObj = null;
         rootFObj = null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public boolean hasData() {
         return rootFObj != null;
     }
 
+    /**
+     * Returns the logger.
+     * @return The logger.
+     */
     public Log getLogger() {
         return this.logger;
     }
 
+    /**
+     * Returns the line number currently showing in the SAX Locator.
+     * @return The line number currently showing in the SAX Locator.
+     */
     private int getLine() {
         int line = -1;
         if (locator != null) {
@@ -290,6 +304,10 @@
         return line;
     }
 
+    /**
+     * Returns the column number currently showing in the SAX Locator.
+     * @return The column number currently showing in the SAX Locator.
+     */
     private int getColumn() {
         int column = -1;
         if (locator != null) {
@@ -371,18 +389,34 @@
         }
     }
 
+    /**
+     * Return the FO namespace instance.
+     * @return The FO namespace instance.
+     */
     public NamespaceFO getFONamespace() {
         return getTreeServer().getFONamespace();
     }
 
+    /**
+     * Return the Extension namespace instance.
+     * @return The Extension namespace instance.
+     */
     public NamespaceExtensions getExtensionNamespace() {
         return getTreeServer().getExtensionNamespace();
     }
 
+    /**
+     * Return the SVG namespace instance.
+     * @return The SVG namespace instance.
+     */
     public NamespaceSVG getSVGNamespace() {
         return getTreeServer().getSVGNamespace();
     }
 
+    /**
+     * Return the XML namespace instance.
+     * @return The XML namespace instance.
+     */
     public NamespaceXML getXMLNamespace() {
         return getTreeServer().getXMLNamespace();
     }

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjMixed.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjMixed.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjMixed.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -35,6 +35,8 @@
  */
 public abstract class FObjMixed extends FObj {
 
+    /** The text buffer used to accumulate the text portion of the mixed
+     * content. */
     private StringBuilder textBuffer;
 
     /**
@@ -51,6 +53,10 @@
         super(parent, propertyList, systemId, line, column);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
     protected void addCharacters(final char data[], final int start,
             final int length, final String systemId, final int line,
             final int column) {
@@ -60,6 +66,9 @@
         textBuffer.append(data, start, length);
     }
 
+    /**
+     * Flushes any remaining text into an FOText item.
+     */
     protected void finalizeText() {
         if (! this.shouldCreateFOText()) {
             return;
@@ -70,6 +79,11 @@
         textBuffer.setLength(0);
     }
 
+    /**
+     * Indicates whether an FOText item should be created from the buffer.
+     * @return True iff an FOText item should be created from the buffer
+     * contents.
+     */
     private boolean shouldCreateFOText() {
         if (textBuffer == null) {
             return false;
@@ -94,11 +108,18 @@
      */
     public abstract boolean blockMustEnclosePCDATA();
 
+    /**
+     * {@inheritDoc}
+     */
     protected void end() throws FOTreeException {
         finalizeText();
         textBuffer = null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
     protected void addChild(final FONode child) {
         /*
          * Before adding the element child, see if there is any text in the
@@ -110,14 +131,26 @@
         super.addChild(child);
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
     public boolean canContainBlock() {
         return true;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
     public boolean canContainInline() {
         return true;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
     public boolean canContainPCDATA() {
         return true;
     }

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjScaled.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjScaled.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/FObjScaled.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -55,6 +55,8 @@
 
     /**
      * Returns the width of the content.
+     * @param context An object that knows how to resolve FO Tree context
+     * issues.
      * @return The width, in millipoints, of the content of this object, as
      * reported by the content itself.
      */
@@ -62,6 +64,8 @@
 
     /**
      * Returns the height of the content.
+     * @param context An object that knows how to resolve FO Tree context
+     * issues.
      * @return The height, in millipoints, of the content of this object, as
      * reported by the content itself.
      */
@@ -109,6 +113,8 @@
      * Converts a quantity of pixels to a length in millipoints, using the
      * value passed in pixelsPerInch.
      * @param pixels The quantity of pixels to be converted to millipoints.
+     * @param pixelsPerInch The resolution, in pixels-per-inch, at which the
+     * conversion should take place.
      * @return The millipoint equivalent of pixels.
      */
     public static int pixelsToMillipoints(final int pixels,

Modified: trunk/foray/foray-fotree/src/java/org/foray/fotree/ForeignXML.java
===================================================================
--- trunk/foray/foray-fotree/src/java/org/foray/fotree/ForeignXML.java	2007-03-31 00:58:11 UTC (rev 9055)
+++ trunk/foray/foray-fotree/src/java/org/foray/fotree/ForeignXML.java	2007-03-31 01:28:52 UTC (rev 9056)
@@ -139,6 +139,16 @@
      * This is pretending to be a SAX Handler for the start of an element.
      * Control is passed here from FOTreeBuilder while foreign XML is being
      * processed.
+     * @param namespaceURI The Namespace URI, or the empty string if the element
+     * has no Namespace URI or if Namespace processing is not being performed.
+     * @param localName The local name (without prefix), or the empty string if
+     * Namespace processing is not being performed.
+     * @param rawName The qualified name (with prefix), or the empty string if
+     * qualified names are not available.
+     * @param attlist The attributes attached to the element. If there are no
+     * attributes, it shall be an empty Attributes object.
+     * @exception org.xml.sax.SAXException Any SAX exception, possibly wrapping
+     * another exception.
      */
     public void startElement(final String namespaceURI, final String localName,
             final String rawName, final Attributes attlist)
@@ -172,6 +182,14 @@
      * This is pretending to be a SAX Handler for the end of an element.
      * Control is passed here from FOTreeBuilder while foreign XML is being
      * processed.
+     * @param uri The Namespace URI, or the empty string if the element has no
+     * Namespace URI or if Namespace processing is not being performed.
+     * @param localName The local name (without prefix), or the empty string if
+     * Namespace processing is not being performed.
+     * @param rawName The qualified name (with prefix), or the empty string if
+     * qualified names are not available.
+     * @exception org.xml.sax.SAXException Any SAX exception, possibly wrapping
+     * another exception.
      */
     public void endElement(final String uri, final String localName,
             final String rawName) throws SAXException {
@@ -200,14 +218,27 @@
      * an element.
      * Control is passed here from FOTreeBuilder while foreign XML is being
      * processed.
+     * @param data The characters.
+     * @param start The start position in the character array.
+     * @param length The number of characters to use from the character array.
      */
     protected void characters(final char[] data, final int start,
             final int length) {
         this.stringBuffer.append(data, start, length);
     }
 
+    /**
+     * Returns the intrinsic content width of the foreign XML item.
+     * @return The intrinsic content width of the foreign XML item,
+     * in millipoints.
+     */
     public abstract int intrinsicContentWidth();
 
+    /**
+     * Returns the intrinsic content height of the foreign XML item.
+     * @return The intrinsic content height of the foreign XML item,
+     * in millipoints.
+     */
     public abstract int intrinsicContentHeight();
 
 }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




2006	Jan	Feb	Mar (139)	Apr (98)	May (250)	Jun (394)	Jul (84)	Aug (13)	Sep (420)	Oct (186)	Nov (1)	Dec (3)
2007	Jan (108)	Feb (202)	Mar (291)	Apr (247)	May (374)	Jun (227)	Jul (231)	Aug (60)	Sep (31)	Oct (45)	Nov (18)	Dec
2008	Jan (38)	Feb (71)	Mar (142)	Apr	May (59)	Jun (6)	Jul (10)	Aug	Sep	Oct	Nov	Dec
2009	Jan (12)	Feb (4)	Mar (88)	Apr (121)	May (17)	Jun (30)	Jul	Aug (5)	Sep	Oct (1)	Nov	Dec
2010	Jan (11)	Feb (76)	Mar (11)	Apr	May (11)	Jun	Jul	Aug (44)	Sep (14)	Oct (7)	Nov	Dec
2011	Jan	Feb	Mar	Apr	May (9)	Jun	Jul	Aug	Sep	Oct (10)	Nov	Dec
2012	Jan	Feb	Mar	Apr	May	Jun (3)	Jul (4)	Aug	Sep	Oct	Nov	Dec
2016	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec (168)
2017	Jan (77)	Feb (11)	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2018	Jan	Feb	Mar (1)	Apr (6)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2019	Jan	Feb (88)	Mar (118)	Apr (1)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2020	Jan	Feb	Mar	Apr	May (6)	Jun	Jul	Aug	Sep	Oct	Nov	Dec (141)
2021	Jan (170)	Feb (20)	Mar	Apr	May	Jun	Jul (1)	Aug	Sep	Oct (62)	Nov (189)	Dec (162)
2022	Jan (201)	Feb (118)	Mar (8)	Apr	May (2)	Jun (47)	Jul (19)	Aug (14)	Sep (3)	Oct	Nov (28)	Dec (235)
2023	Jan (112)	Feb (23)	Mar (2)	Apr (2)	May	Jun (1)	Jul	Aug (70)	Sep (92)	Oct (20)	Nov (1)	Dec (1)
2024	Jan	Feb	Mar (1)	Apr (1)	May (14)	Jun (11)	Jul (1)	Aug	Sep	Oct	Nov	Dec
2025	Jan (10)	Feb (29)	Mar	Apr (162)	May (245)	Jun (83)	Jul	Aug (1)	Sep	Oct	Nov	Dec

S	M	T	W	T	F	S
				1	2	3
4	5	6	7	8	9 (1)	10 (20)
11	12 (6)	13 (22)	14 (29)	15 (24)	16 (22)	17
18 (19)	19 (6)	20 (22)	21 (30)	22 (14)	23 (13)	24 (9)
25 (1)	26 (21)	27 (18)	28	29	30 (11)	31 (3)

foray-commit Mailing List for FOray

Modular XSL-FO Implementation for Java.

foray-commit — FOray repository commit log messages