[FOray-commit] SF.net SVN: foray: [7849] trunk/foray/foray-areatree/src/java/org/foray/ area

[<vic...@us...>]

Revision: 7849
          http://svn.sourceforge.net/foray/?rev=7849&view=rev
Author:   victormote
Date:     2006-09-01 13:19:23 -0700 (Fri, 01 Sep 2006)

Log Message:
-----------
Add some javadoc.

Modified Paths:
--------------
    trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java
    trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
    trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
    trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java
    trunk/foray/foray-areatree/src/java/org/foray/area/ForeignObjectArea.java
    trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java
    trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
    trunk/foray/foray-areatree/src/java/org/foray/area/ListBlockArea.java
    trunk/foray/foray-areatree/src/java/org/foray/area/ListItemArea.java
    trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java
    trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
    trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
    trunk/foray/foray-areatree/src/java/org/foray/area/TableBodyContainer.java
    trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java
    trunk/foray/foray-areatree/src/java/org/foray/area/TableFooterContainer.java
    trunk/foray/foray-areatree/src/java/org/foray/area/TableHeaderContainer.java

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AbstractTableContainer.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -31,6 +31,9 @@
 import org.axsl.foR.fo.TableRow;
 import org.axsl.graphicR.Graphic;
 
+/**
+ * Abstract superclass for table-body, table-header, and table-footer areas.
+ */
 public abstract class AbstractTableContainer extends GenericContainer
         implements BackgroundArea,
         org.axsl.areaW.AbstractTableContainer {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/Area.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/Area.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/Area.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -47,6 +47,9 @@
 import java.awt.geom.Rectangle2D;
 import java.util.List;
 
+/**
+ * Abstract superclass for all Areas in the AreaTree.
+ */
 public abstract class Area extends AreaNode implements org.axsl.areaR.Area,
         org.axsl.areaW.Area {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/AreaNode.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -42,6 +42,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Abstract superclass for all nodes in the AreaTree.
+ */
 public abstract class AreaNode extends OrderedTreeNode
         implements org.axsl.areaR.AreaNode, org.axsl.areaW.AreaNode {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/ExternalGraphicArea.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -30,6 +30,9 @@
 
 import org.axsl.graphicR.Graphic;
 
+/**
+ * Area containing an external-graphic.
+ */
 public class ExternalGraphicArea extends AbstractInlineArea
         implements org.axsl.areaR.ExternalGraphicArea,
         org.axsl.areaW.ExternalGraphicArea {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/ForeignObjectArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/ForeignObjectArea.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/ForeignObjectArea.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -30,6 +30,9 @@
 import org.axsl.foR.fo.RetrieveMarker;
 import org.axsl.foR.svg.SVGElement;
 
+/**
+ * Area containing a foreign-object.
+ */
 public class ForeignObjectArea extends AbstractInlineArea
         implements org.axsl.areaR.ForeignObjectArea,
         org.axsl.areaW.ForeignObjectArea {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/GenericContainer.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -27,6 +27,9 @@
 import org.axsl.foR.FObj;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Abstract superclass for generic container Areas.
+ */
 public abstract class GenericContainer extends ContainerRA
         implements org.axsl.areaW.GenericContainer {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/LineArea.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -42,6 +42,9 @@
 
 import java.util.List;
 
+/**
+ * Area containing a line of content on the page.
+ */
 public class LineArea extends BlockArea implements LineOutput,
         org.axsl.areaR.LineArea,
         org.axsl.areaW.LineArea {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/ListBlockArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/ListBlockArea.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/ListBlockArea.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -29,6 +29,9 @@
 import org.axsl.foR.fo.ListItem;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Area containing all or part of a list-block.
+ */
 public class ListBlockArea extends AbstractNormalBlockArea
         implements org.axsl.areaR.ListBlockArea, org.axsl.areaW.ListBlockArea {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/ListItemArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/ListItemArea.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/ListItemArea.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -28,6 +28,9 @@
 import org.axsl.foR.fo.ListItem;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Area containing all or part of a list-item.
+ */
 public class ListItemArea extends AbstractNormalBlockArea
         implements org.axsl.areaW.ListItemArea {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageNumberCitationArea.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -28,6 +28,9 @@
 import org.axsl.foR.FObj;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Area containing all or part of a page-number-citation.
+ */
 public class PageNumberCitationArea extends AbstractInlineArea
         implements org.axsl.areaR.PageNumberCitationArea,
         org.axsl.areaW.PageNumberCitationArea {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/PageRA.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -45,6 +45,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Area containing a page.
+ */
 public class PageRA extends AreaFixed implements PageArea,
         org.axsl.areaW.PageArea {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/RegionRABody.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -33,6 +33,9 @@
 import org.axsl.foR.fo.SimplePageMaster;
 import org.axsl.graphicR.Graphic;
 
+/**
+ * Area containing a region-body.
+ */
 public class RegionRABody extends AreaFixed implements RegionBodyArea,
         org.axsl.areaW.RegionRABody {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableBodyContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableBodyContainer.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableBodyContainer.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -28,6 +28,9 @@
 import org.axsl.foR.FObj;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Area containing all or part of a table-body.
+ */
 public class TableBodyContainer extends AbstractTableContainer
         implements org.axsl.areaR.BackgroundArea,
         org.axsl.areaW.TableBodyContainer {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableCellRA.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -31,6 +31,9 @@
 import org.axsl.foR.fo.TableCell;
 import org.axsl.graphicR.Graphic;
 
+/**
+ * Area containing all or part of a table-cell.
+ */
 public class TableCellRA extends ContainerRA implements TableCellArea,
         org.axsl.areaW.TableCellArea {
 

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableFooterContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableFooterContainer.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableFooterContainer.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -28,6 +28,9 @@
 import org.axsl.foR.FObj;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Area containing all or part of a table-footer.
+ */
 public class TableFooterContainer extends AbstractTableContainer
         implements org.axsl.areaR.BackgroundArea,
         org.axsl.areaW.TableFooterContainer {

Modified: trunk/foray/foray-areatree/src/java/org/foray/area/TableHeaderContainer.java
===================================================================
--- trunk/foray/foray-areatree/src/java/org/foray/area/TableHeaderContainer.java	2006-09-01 20:12:29 UTC (rev 7848)
+++ trunk/foray/foray-areatree/src/java/org/foray/area/TableHeaderContainer.java	2006-09-01 20:19:23 UTC (rev 7849)
@@ -28,6 +28,9 @@
 import org.axsl.foR.FObj;
 import org.axsl.foR.fo.RetrieveMarker;
 
+/**
+ * Area containing all or part of a table-header.
+ */
 public class TableHeaderContainer extends AbstractTableContainer
         implements org.axsl.areaR.BackgroundArea,
         org.axsl.areaW.TableHeaderContainer {


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