Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

some javadoc cleanup #323

Merged
merged 1 commit into from
Nov 17, 2012
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxExpansion.java
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ public boolean isAjaxRequest() {

/**
* Returns an escaped version of {@link #string()} using
* {@link ERXStringUtilities#escapeJavascriptApostrophes(String)}.
* {@link er.extensions.foundation.ERXStringUtilities#escapeJavascriptApostrophes(String)}.
*
* @return escaped string
*/
Expand Down
8 changes: 4 additions & 4 deletions Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxResponse.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public class AjaxResponse extends ERXResponse {
* tag along. For instance, if you have an area at the top of your pages that
* show errors or notifications, you may want all of your ajax responses to have
* a chance to trigger an update of this area, so you could register an
* AjaxResponseAppender that renders a javascript block that calls
* {@link er.ajax.AjaxResponseAppender} that renders a javascript block that calls
* MyNotificationsUpdate() only if there are notifications to be shown. Without
* response appenders, you would have to include a check in all of your
* components to do this.
Expand Down Expand Up @@ -151,23 +151,23 @@ public WOActionResults handleNullActionResults(WORequest request, WOResponse res

/**
* Convenience method that calls <code>AjaxUtils.appendScriptHeaderIfNecessary</code> with this request.
* @see AjaxUtils#appendScriptHeaderIfNecessary(WORequest, WOResponse)
* @see er.ajax.AjaxUtils#appendScriptHeaderIfNecessary(WORequest, WOResponse)
*/
public void appendScriptHeaderIfNecessary() {
AjaxUtils.appendScriptHeaderIfNecessary(_request, this);
}

/**
* Convenience method that calls <code>AjaxUtils.appendScriptFooterIfNecessary</code> with this request.
* @see AjaxUtils#appendScriptFooterIfNecessary(WORequest, WOResponse)
* @see er.ajax.AjaxUtils#appendScriptFooterIfNecessary(WORequest, WOResponse)
*/
public void appendScriptFooterIfNecessary() {
AjaxUtils.appendScriptFooterIfNecessary(_request, this);
}

/**
* Convenience method that calls <code>AjaxUtils.updateDomElement</code> with this request.
* @see AjaxUtils#updateDomElement(WOResponse, String, Object, String, String, String)
* @see er.ajax.AjaxUtils#updateDomElement(WOResponse, String, Object, String, String, String)
*/
public void updateDomElement(String id, Object value, String numberFormat, String dateFormat, String valueWhenEmpty) {
AjaxUtils.updateDomElement(this, id, value, numberFormat, dateFormat, valueWhenEmpty);
Expand Down
12 changes: 6 additions & 6 deletions Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public static void addScriptResourceInHead(WOContext context, WOResponse respons
}

/**
* Calls ERXWOContext.addScriptResourceInHead with "Ajax" framework
* Calls {@link ERXResponseRewriter#addScriptResourceInHead(WOContext, WOResponse, String, String)} with "Ajax" framework
*
* @param context
* @param response
Expand All @@ -139,7 +139,7 @@ public static void addScriptResourceInHead(WOContext context, WOResponse respons
}

/**
* Calls ERXWOContext.addStylesheetResourceInHead
* Calls {@link ERXResponseRewriter#addStylesheetResourceInHead(WOContext, WOResponse, String, String)}
*
* @param context
* @param response
Expand All @@ -151,7 +151,7 @@ public static void addStylesheetResourceInHead(WOContext context, WOResponse res
}

/**
* Calls ERXWOContext.addStylesheetResourceInHead with "Ajax" framework
* Calls {@link ERXResponseRewriter#addStylesheetResourceInHead(WOContext, WOResponse, String, String)} with "Ajax" framework
*
* @param context
* @param response
Expand Down Expand Up @@ -200,7 +200,7 @@ public static void addResourceInHead(WOContext context, WOResponse response, Str
}

/**
* Calls ERXWOContext.addScriptCodeInHead.
* Calls {@link er.extensions.appserver.ERXResponseRewriter#addScriptCodeInHead(WOResponse, WOContext, String)}.
*
* @param response
* @param context
Expand All @@ -211,7 +211,7 @@ public static void addScriptCodeInHead(WOResponse response, WOContext context, S
}

/**
* @deprecated use {@link ERXStringUtilities#safeIdentifierName(String)}
* @deprecated use {@link er.extensions.foundation.ERXStringUtilities#safeIdentifierName(String)}
*/
@Deprecated
public static String toSafeElementID(String elementID) {
Expand Down Expand Up @@ -255,7 +255,7 @@ public static void updateMutableUserInfoWithAjaxInfo(WOMessage message) {
}

/**
* Returns an AjaxResponse with the given javascript as the body of the response.
* Returns an {@link er.ajax.AjaxResponse} with the given javascript as the body of the response.
*
* @param context the WOContext
* @param javascript the javascript to send
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@
* Principle class of the ERDirectToWeb framework.
* This class is loaded when the NSBundle of this
* framework is loaded. When loaded this class configures
* the directtoweb runtime to use the {@link ERD2WModel} and
* {@link ERD2WFactory} subclasses instead of the default
* the directtoweb runtime to use the {@link er.directtoweb.ERD2WModel} and
* {@link er.directtoweb.ERD2WFactory} subclasses instead of the default
* implementations. See each class for a description of the
* additions/improvements made to the base implementation.
* This class also has a bunch of utility methods that are
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import er.directtoweb.assignments.defaults.ERDDefaultConfigurationNameAssignment;

/**
* @deprecated use {@link ERDDefaultConfigurationNameAssignment}
* @deprecated use {@link er.directtoweb.assignments.defaults.ERDDefaultConfigurationNameAssignment}
*/
@Deprecated
public class ERDConfigurationAssignment extends ERDDefaultConfigurationNameAssignment {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import er.extensions.eof.ERXEOAccessUtilities;

/**
* @deprecated use a {@link ERDKeyValueAssignment} or a {@link ERDDefaultModelAssignment} with key entityForPageConfiguration instead
* @deprecated use a {@link er.directtoweb.assignments.ERDKeyValueAssignment} or a {@link er.directtoweb.assignments.defaults.ERDDefaultModelAssignment} with key entityForPageConfiguration instead
*/
@Deprecated
public class ERDEntityAssignment extends Assignment implements ERDComputingAssignmentInterface {
Expand Down Expand Up @@ -64,7 +64,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDEntityAssignment(String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context key: "pageConfiguration". This key
* is used when constructing the significant keys for the passed in keyPath.
* @param keyPath to compute significant keys for.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDImageNameAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "baseImageDirectory", "sectionKey",
* and "tabKey". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* Assignment used to create objects on the fly. You use this by
* specifing the class name as a string, ie "foo.bar.MyClass". This
* will create an instance of the MyClass object.
* @deprecated use {@link ERDDelayedObjectCreationAssignment}
* @deprecated use {@link er.directtoweb.assignments.delayed.ERDDelayedObjectCreationAssignment}
*/
@Deprecated
public class ERDInstanceCreationAssignment extends ERDDelayedAssignment {
Expand Down Expand Up @@ -66,7 +66,7 @@ public ERDInstanceCreationAssignment (EOKeyValueUnarchiver u) {
public ERDInstanceCreationAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context key: "entity.name". This array
* of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
import com.webobjects.directtoweb.D2WContext;
import com.webobjects.eocontrol.EOKeyValueUnarchiver;

import er.directtoweb.assignments.delayed.ERDDelayedKeyValueAssignment;

/**
* Piece of crap. This assignment works around the
* fact that KeyValueAssignment isn't public (and should be).
Expand All @@ -21,7 +19,7 @@
* assignment will be cached the first time this assignment is
* fired. To have a key value assignment that does not cache
* the value returned the first time have a look at
* {@link ERDDelayedKeyValueAssignment}.
* {@link er.directtoweb.assignments.delayed.ERDDelayedKeyValueAssignment}.
*/
public class ERDKeyValueAssignment extends Assignment {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDLocalizedAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the template keys from the value of this assignment.
* This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import er.directtoweb.assignments.delayed.ERDDelayedLocalizedAssignment;

/**
* @deprecated use {@link ERDDelayedLocalizedAssignment}
* @deprecated use {@link er.directtoweb.assignments.delayed.ERDDelayedLocalizedAssignment}
*/
@Deprecated
public class ERDLocalizedMessageAssignment extends ERDDelayedLocalizedAssignment {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
/**
* Relationship sort assignment that works with the new caching
* scheme. Should only ever need one of these assignments.
* @deprecated use {@link ERDDefaultModelAssignment}
* @deprecated use {@link er.directtoweb.assignments.defaults.ERDDefaultModelAssignment}
*/
@Deprecated
public class ERDRelationshipSortAssignment extends ERDAssignment {
Expand Down Expand Up @@ -60,7 +60,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDRelationshipSortAssignment(EOKeyValueUnarchiver unarchiver) { super(unarchiver); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "propertyKey" and
* "keyWhenRelationship". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* not find it is that it uses the Model to find out the EOAttribute
* and starts from A. Following the relationship b, gives a B, and
* asking B for an attribute named k returns nil and you lose.
* @deprecated use {@link ERDDefaultModelAssignment}
* @deprecated use {@link er.directtoweb.assignments.defaults.ERDDefaultModelAssignment}
*/
// Note that these assignments require that the object is pushed into the context. Look
// on some of the ERInspectPage setObject methods we push the object into the context.
Expand Down Expand Up @@ -62,7 +62,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
}

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "object.entityName" and
* "propertyKey". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* find it is that it uses the Model to find out the EORelationship
* and starts from A. Following the relationship b, gives a B, and
* asking B for a relationship named k returns null and you lose.
* @deprecated use {@link ERDDefaultModelAssignment}
* @deprecated use {@link er.directtoweb.assignments.defaults.ERDDefaultModelAssignment}
*/
// Note that these assignments require that the object is pushed into the context. Look
// on some of the ERInspectPage setObject methods we push the object into the context.
Expand Down Expand Up @@ -63,7 +63,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
}

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "propertyKey" and
* "object.entityName". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDSortedManyToManyAssignment(EOKeyValueUnarchiver unarchiver) { super(unarchiver); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "propertyKey" and
* "keyWhenRelationship". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// MOVEME: ERDConfigurationAssignment
/**
* Generated pageConfigurations that will use the tab inspect templates.<br />
* @deprecated use {@link ERDDefaultConfigurationNameAssignment} with key inspectTabConfigurationName
* @deprecated use {@link er.directtoweb.assignments.defaults.ERDDefaultConfigurationNameAssignment} with key inspectTabConfigurationName
*/
@Deprecated
public class ERDTabConfigurationAssignment extends ERDDefaultConfigurationNameAssignment {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDTabDictionaryComputer (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context key: "displayPropertyKeys".
* This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@
import com.webobjects.foundation.NSMutableArray;

import er.directtoweb.ERD2WContainer;
import er.directtoweb.pages.ERD2WTabInspectPage;

/**
* Assignment used to construct and cache the
* tab sections containers used with tab insepct
* pages. See {@link ERD2WTabInspectPage} for
* pages. See {@link er.directtoweb.pages.ERD2WTabInspectPage} for
* information on the formats of a tab section.
*/
// FIXME: Should subclass Assignment instead
Expand Down Expand Up @@ -58,7 +57,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDTabSectionsContentsAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment is not dependent on any context keys.
* @return empty array.
*/
Expand All @@ -67,9 +66,9 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
/**
* Called when firing this assignment with the key-path:
* <b>tabSectionsContents</b>. Constructs an array of
* {@link ERD2WContainer}s representing each tab and
* {@link er.directtoweb.ERD2WContainer}s representing each tab and
* optionally another array of containers representing
* each section. See {@link ERD2WTabInspectPage} for the
* each section. See {@link er.directtoweb.pages.ERD2WTabInspectPage} for the
* exact format of the tabs and sections.
* @return array of containers for each tab
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
import com.webobjects.foundation.NSMutableArray;

import er.directtoweb.assignments.ERDAssignment;
import er.directtoweb.assignments.ERDComputingAssignmentInterface;

/**
* This assignment calculates default actions for the current page
Expand Down Expand Up @@ -56,7 +55,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDDefaultActionAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "entity.name" and
* "object.entityName". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* Note: As they mirror the default configurations, the assignment class is separate (and a subclass).
* This means that the default configurations can be overridden in the rules more gracefully.
*
* @see ERDDefaultConfigurationNameAssignment
* @see er.directtoweb.assignments.defaults.ERDDefaultConfigurationNameAssignment
*
* @author mendis
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,13 @@
import com.webobjects.foundation.NSArray;

import er.directtoweb.assignments.ERDAssignment;
import er.directtoweb.assignments.ERDComputingAssignmentInterface;
import er.directtoweb.assignments.ERDLocalizableAssignmentInterface;
import er.directtoweb.assignments.ERDLocalizedAssignment;

// FIXME: Should be renamed ERDDefaultLocalizedMessageAssignment.
/**
* Message assignment used when hitting a cancel button, just a little "Are you sure?" kind of thing.<br />
* @deprecated use {@link ERDLocalizedAssignment}
* @deprecated use {@link er.directtoweb.assignments.ERDLocalizedAssignment}
*/
@Deprecated
public class ERDDefaultCancelCreationMessageAssignment extends ERDAssignment implements ERDLocalizableAssignmentInterface {
Expand Down Expand Up @@ -60,7 +59,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDDefaultCancelCreationMessageAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context key: "entity.name". This array
* of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public class ERDDefaultClassStringAssignment extends ERDAssignment {
});

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This array
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This array
* of keys is used when constructing the
* significant keys for the passed in keyPath.
* @param keyPath to compute significant keys for.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public static Object decodeWithKeyValueUnarchiver(EOKeyValueUnarchiver eokeyvalu
public ERDDefaultConfigurationNameAssignment (String key, Object value) { super(key,value); }

/**
* Implementation of the {@link ERDComputingAssignmentInterface}. This
* Implementation of the {@link er.directtoweb.assignments.ERDComputingAssignmentInterface}. This
* assignment depends upon the context keys: "entity.name" and
* "object.entityName". This array of keys is used when constructing the
* significant keys for the passed in keyPath.
Expand Down
Loading