From: <ki...@us...> - 2008-11-27 02:52:19
|
Revision: 8676 http://wonder.svn.sourceforge.net/wonder/?rev=8676&view=rev Author: kiddyr Date: 2008-11-27 02:52:14 +0000 (Thu, 27 Nov 2008) Log Message: ----------- Javadoc-only fixes. Modified Paths: -------------- trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONBridge.java trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONRequestHandler.java trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/serializer/EOEnterpriseObjectSerializer.java trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/SCUtilities.java trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/views/SCComponent.java trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggable.java trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggableEntity.java trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERD2WDirectAction.java trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERDirectToWeb.java trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDBranchDelegate.java trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDFlowDelegate.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/ERXExtensions.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXApplication.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDelayedRequestHandler.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDirectActionRequestHandler.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXPathDirectActionRequestHandler.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXWOContext.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/components/ERXAccessibleSubmitButton.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXAdaptorChannelDelegate.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXDatabaseContextDelegate.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEOControlUtilities.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEnterpriseObjectCache.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchResultCache.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchSpecification.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXGroupingFetchSpecification.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXModelGroup.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXDictionaryUtilities.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXExpiringCache.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXRuntimeUtilities.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXStringUtilities.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/jdbc/ERXSQLHelper.java trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/qualifiers/IERXChainableQualifier.java trunk/Wonder/Frameworks/EOF/ERRest/Sources/er/rest/ERXRestRequestHandler.java trunk/Wonder/Frameworks/PlugIns/DerbyPlugIn/Sources/com/webobjects/jdbcadaptor/DerbyPlugIn.java trunk/Wonder/Frameworks/PlugIns/FrontBasePlugIn/Sources/com/webobjects/jdbcadaptor/_FrontBasePlugIn.java trunk/Wonder/Frameworks/PlugIns/PostgresqlPlugIn/Sources/com/webobjects/jdbcadaptor/PostgresqlPlugIn.java Modified: trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONBridge.java =================================================================== --- trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONBridge.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONBridge.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -53,7 +53,6 @@ /** * Factory to create a json bridge. - * @return */ public static JSONBridge createBridge() { _initializeBridge(); Modified: trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONRequestHandler.java =================================================================== --- trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONRequestHandler.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/JSONRequestHandler.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -174,8 +174,7 @@ * * @param context the current WOContext * @param requestHandlerKey if you registered a custom JSON request handler key - * @param componentName the name of the component to lookup (or null for the shared bridge) - * @param componentInstance the instance identifier (any value) to create a unique instance (or null for a session-global) + * @param componentNameAndInstance the name/instance identifier of the component to lookup (or null for the shared bridge) * @param queryString the query string to append * @return a JSON request handler URL */ Modified: trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/serializer/EOEnterpriseObjectSerializer.java =================================================================== --- trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/serializer/EOEnterpriseObjectSerializer.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/json/serializer/EOEnterpriseObjectSerializer.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -287,8 +287,7 @@ /** * Override to return whether or not a new entity can be inserted. - * @param eo - * @return + * @param entityName */ protected boolean _canInsert(String entityName) { return ERXProperties.booleanForKeyWithDefault("er.ajax.json." + entityName + ".canInsert", false); @@ -297,7 +296,6 @@ /** * Override to return the appropriate attribute names. * @param eo - * @return */ protected NSArray<String> _readableAttributeNames(EOEnterpriseObject eo) { return EOEnterpriseObjectSerializer.readableAttributeNames(eo); @@ -306,7 +304,6 @@ /** * Override to return the appropriate attribute names. * @param eo - * @return */ protected NSArray<String> _writableAttributeNames(EOEnterpriseObject eo) { return EOEnterpriseObjectSerializer.writableAttributeNames(eo); @@ -315,7 +312,6 @@ /** * Override to return the appropriate relationship names. * @param eo - * @return */ protected NSArray<String> _includedRelationshipNames(EOEnterpriseObject eo) { return EOEnterpriseObjectSerializer.includedRelationshipNames(eo); Modified: trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/SCUtilities.java =================================================================== --- trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/SCUtilities.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/SCUtilities.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -35,8 +35,6 @@ * Returns an external URL for the sproutcore libs to prepend via the * property <code>er.sproutcore.base</code> or the empty String. MUST end * with "/" if set. - * - * @return */ public static String scBase() { if (scBase == null) { Modified: trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/views/SCComponent.java =================================================================== --- trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/views/SCComponent.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Ajax/SproutCore/Sources/er/sproutcore/views/SCComponent.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -204,8 +204,6 @@ /** * Returns a nice class name like MyApp.MyView. - * - * @return */ protected String className() { return _className; Modified: trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggable.java =================================================================== --- trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggable.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggable.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -121,7 +121,7 @@ * This method removes tags from the target object, by looking up the corresponding * Tag object instances and removing them from the tag collection of the object if they exist. * - * @param tags the tags to remove (String to tokenize, NSArray<String>, etc) + * @param tagName the tag to remove (String to tokenize, NSArray<String>, etc) */ @SuppressWarnings("unchecked") public void removeTagNamed(String tagName) { Modified: trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggableEntity.java =================================================================== --- trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggableEntity.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/BusinessLogic/ERTaggable/Sources/er/taggable/ERTaggableEntity.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -91,8 +91,6 @@ * Constructs an ERTaggableEntity. * * @param entity the entity to tag - * @param tagsRelationshipName the name of the flattened to-many relationship to the tag entity - * @param tagEntityName the name of the tag entity */ @SuppressWarnings("unchecked") protected ERTaggableEntity(EOEntity entity) { @@ -134,8 +132,6 @@ * Constructs an ERTaggableEntity. * * @param entity the entity to tag - * @param tagsRelationshipName the name of the flattened to-many relationship to the tag entity - * @param tagEntity the tag entity */ @SuppressWarnings("unchecked") public static <T extends ERXGenericRecord> ERTaggableEntity<T> taggableEntity(EOEntity entity) { @@ -736,7 +732,7 @@ * @param editingContext the editing context to remove with * @param oldTags the tags to find and remove (String to tokenize, NSArray<String>, etc) * @param newTags the tags to add - * @param inclusiong if ANY, finds any tags that match, removes them all, and adds newTags; if all, requires all tags to match before replacing + * @param inclusion if ANY, finds any tags that match, removes them all, and adds newTags; if all, requires all tags to match before replacing */ public void replaceTags(EOEditingContext editingContext, ERTag.Inclusion inclusion, Object oldTags, Object newTags) { for (T item : fetchTaggedWith(editingContext, inclusion, oldTags)) { Modified: trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERD2WDirectAction.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERD2WDirectAction.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERD2WDirectAction.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -363,7 +363,6 @@ /** * Returns an error page and sets the message to the key<code> __message</code>. - * @return */ protected WOActionResults prepareErrorPage(D2WContext d2wContext, ErrorPageInterface epi) { WOActionResults newPage = null; @@ -386,7 +385,6 @@ /** * Creates an error page with the given exception. * @param ex - * @return */ public WOActionResults reportException(Exception ex) { WOActionResults newPage = null; Modified: trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERDirectToWeb.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERDirectToWeb.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/ERDirectToWeb.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -180,9 +180,11 @@ /** * Checks if a given property key is in the format (foo) or [foo] and returns the stripped string. + * * @param s the String to convert * @param start the start char - * @param start the end char to check for + * @param end the end char to check for + * * @return stripped String or null if the string does not start with <code>start</code> and ends with <code>end</code>. */ public static String convertedPropertyKeyFromString(String s, char start, char end) { Modified: trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDBranchDelegate.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDBranchDelegate.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDBranchDelegate.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -54,19 +54,16 @@ public @interface D2WDelegate { /** * Returns the names of the scope where you can have this method. One of "selection,object" - * @return */ public String scope() default ""; /** * Returns the names of the tasks where you can have this method. Example "query,select" - * @return */ public String availableTasks() default ""; /** * Returns the names of the pages where you can have this method. Example "ListWebMaster,QueryWebMaster" - * @return */ public String availablePages() default ""; } Modified: trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDFlowDelegate.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDFlowDelegate.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERDirectToWeb/Sources/er/directtoweb/delegates/ERDFlowDelegate.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -54,7 +54,6 @@ /** * Returns the current component. - * @return */ public WOComponent currentComponent() { return _current; @@ -62,8 +61,6 @@ /** * Returns the current page. - * - * @return */ public WOComponent page() { return currentComponent().context().page(); @@ -71,8 +68,6 @@ /** * Returns the session. - * - * @return */ public WOSession session() { return currentComponent().session(); @@ -84,7 +79,6 @@ * * @param <T> * @param clazz - * @return */ protected <T> T parent(Class<? extends T> clazz) { WOComponent curr = currentComponent(); @@ -103,7 +97,6 @@ * * @param <T> * @param clazz - * @return */ protected <T> T page(Class<? extends T> clazz) { return (T) currentComponent().context().page(); @@ -112,8 +105,6 @@ /** * Returns either the pageConfiguration of the topmost page or the name of * the topmost page. - * - * @return */ protected String pageName() { String pageName = ERD2WFactory.pageConfigurationFromPage(page()); @@ -131,4 +122,4 @@ return (WOComponent) NSKeyValueCoding.Utility.valueForKey(this, "nextPageFrom" + pageName()); } -} \ No newline at end of file +} Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/ERXExtensions.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/ERXExtensions.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/ERXExtensions.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -1266,7 +1266,7 @@ * not need to call this method if you already called initApp. This is lighter-weight than * initApp, and tries to just get enough configured to make EOF work properly. * - * @param mainBundleFile the folder of your main bundle + * @param mainBundleFolder the folder of your main bundle * @param args the commandline arguments for your application */ public static void initEOF(File mainBundleFolder, String[] args) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXApplication.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXApplication.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXApplication.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -1597,7 +1597,6 @@ /** * Returns the delayedRequestHandler, if any is registered. - * @return */ public ERXDelayedRequestHandler delayedRequestHandler() { return (ERXDelayedRequestHandler) requestHandlerForKey(ERXDelayedRequestHandler.KEY); @@ -1627,7 +1626,6 @@ /** * Dispatches the request without checking for the delayedRequestHandler() * @param request - * @return */ public WOResponse dispatchRequestImmediately(WORequest request) { WOResponse response; @@ -2088,7 +2086,6 @@ /** * Makes ERXConstants available for binding in the UI. Bind to <code>application.constants.MyConstantClass</code>. - * @return */ public NSKeyValueCodingAdditions constants() { return new NSKeyValueCodingAdditions() { @@ -2111,4 +2108,4 @@ }; } -} \ No newline at end of file +} Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDelayedRequestHandler.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDelayedRequestHandler.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDelayedRequestHandler.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -267,8 +267,7 @@ /** * Returns true if the request handler key can be handled. * - * @param key - * @return + * @param request */ protected boolean canHandleRequest(WORequest request) { String contentType = request.headerForKey("content-type"); @@ -286,7 +285,6 @@ * @param request * @param delayedRequest * @param id - * @return */ protected WOResponse handle(WORequest request, DelayedRequest delayedRequest, String id) { final ERXApplication app = ERXApplication.erxApplication(); @@ -350,7 +348,6 @@ * session has not been awakened. * * @param request - * @return */ @SuppressWarnings("unchecked") protected WOResponse createErrorResponse(WORequest request) { @@ -370,8 +367,6 @@ * redirect to the entry. * * @param request - * @param url - * @return */ protected WOResponse createStoppedResponse(WORequest request) { final ERXApplication app = ERXApplication.erxApplication(); @@ -393,9 +388,7 @@ * and you probably shouldn't do it either. * * @param request - * @param timeout * @param url - * @return */ protected WOResponse createRefreshResponse(WORequest request, String url) { WOResponse result = new WOResponse(); @@ -420,8 +413,6 @@ /** * Returns the refresh time in seconds for the message page; - * - * @return */ protected int refresh() { return _refreshTimeSeconds; @@ -430,8 +421,6 @@ /** * Returns the maximum time in milliseconds for allowed for a request before * returning the message page. - * - * @return */ protected int maxRequestTimeMillis() { return _maxRequestTimeMillis; @@ -439,8 +428,6 @@ /** * Returns all active delayed requests. - * - * @return */ public NSArray<DelayedRequest> activeRequests() { NSMutableArray<DelayedRequest> result = new NSMutableArray<DelayedRequest>(); @@ -452,4 +439,4 @@ } return result; } -} \ No newline at end of file +} Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDirectActionRequestHandler.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDirectActionRequestHandler.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXDirectActionRequestHandler.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -59,7 +59,6 @@ * Return true if you want to handle the request even though the app is refusing new sessions. * Currently, this includes all urls with "stats" in them * @param request - * @return */ protected boolean isSystemRequest(WORequest request) { return request.requestHandlerPath() != null && request.requestHandlerPath().toLowerCase().indexOf("stats") >= 0; Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXPathDirectActionRequestHandler.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXPathDirectActionRequestHandler.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXPathDirectActionRequestHandler.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -111,7 +111,6 @@ * @param request request to parse * @param useActionClass true if first item should get ignored * @param useActionName true if last item should get ignored - * @return */ public static NSDictionary<String, String> formValuesFromRequest(WORequest request, boolean useActionClass, boolean useActionName) { NSMutableDictionary params = new NSMutableDictionary<String, String>(); Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXWOContext.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXWOContext.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/appserver/ERXWOContext.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -114,8 +114,7 @@ /** * Implemented so the the thread checks if it should get interrupted. * - * @param eoadaptorchannel - * @param nsmutabledictionary + * @param wocomponent */ @Override public void _setCurrentComponent(WOComponent wocomponent) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/components/ERXAccessibleSubmitButton.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/components/ERXAccessibleSubmitButton.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/components/ERXAccessibleSubmitButton.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -213,8 +213,7 @@ } /** - * @param component WOComponent to evaluate the associations in - * @param hotKey the character to check + * @param component WOComponent to evaluate the associations in * @return NSMutableArray containing the hotKeys being used by ERXAccessibleSubmitButtons on this page */ protected NSMutableArray usedHotKeys(WOComponent component) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXAdaptorChannelDelegate.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXAdaptorChannelDelegate.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXAdaptorChannelDelegate.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -32,7 +32,7 @@ * <li>set the er.extensions.ERXAdaptorChannelDelegate.enabled=false in your * properties, which will prevent creation of the channel here * <li>create the channel yourself and set the delegate to - * {@link ERXAdaptorChannelDelegate.defaultDelegate();} + * {@link ERXAdaptorChannelDelegate.defaultDelegate()} * </ul> * otherwise you just need to set * er.extensions.ERXAdaptorChannelDelegate.enabled=true Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXDatabaseContextDelegate.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXDatabaseContextDelegate.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXDatabaseContextDelegate.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -119,7 +119,6 @@ * @param dbc * @param fs * @param ec - * @return */ public NSArray databaseContextShouldFetchObjects(EODatabaseContext dbc, EOFetchSpecification fs, EOEditingContext ec) { NSArray result = null; Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEOControlUtilities.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEOControlUtilities.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEOControlUtilities.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -1036,9 +1036,8 @@ /** * Returns the propertylist-encoded string representation of the global ID. - * @param eo object to get the primary key for. - * @return string representation of the primary key of the - * object. + * @param gid the global id of the oject to get the primary key for. + * @return string representation of the primary key of the object. */ public static String primaryKeyStringForGlobalID(EOKeyGlobalID gid) { if(gid.keyValuesArray().count() > 1) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEnterpriseObjectCache.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEnterpriseObjectCache.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXEnterpriseObjectCache.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -90,7 +90,6 @@ * Creates the cache for the given entity, keypath and timeout value in milliseconds. * @param entityName * @param keyPath - * @param qualifier * @param timeout */ public ERXEnterpriseObjectCache(String entityName, String keyPath, long timeout) { @@ -155,8 +154,6 @@ * Helper to check if an array of EOs contains the handled entity. * @param dict * @param key - * @param eos - * @return */ private NSArray<T> relevantChanges(NSDictionary dict, String key) { NSMutableArray<T> releventEOs = null; @@ -229,7 +226,6 @@ /** * The key path which should get used for the key of the cache. - * @return */ protected String keyPath() { return _keyPath; @@ -237,7 +233,6 @@ /** * Returns the backing cache. If the cache is to old, it is cleared first. - * @return */ protected synchronized ERXExpiringCache<Object, EORecord<T>> cache() { long now = System.currentTimeMillis(); @@ -290,7 +285,6 @@ /** * Returns the objects to cache initially. * @param ec - * @return */ protected NSArray<T> initialObjects(EOEditingContext ec) { NSArray objects = EOUtilities.objectsForEntityNamed(ec, entityName()); @@ -375,7 +369,6 @@ * is in the cache. * @param ec editing context to get the object into * @param key key value under which the object is registered - * @return */ public T objectForKey(EOEditingContext ec, Object key) { return objectForKey(ec, key, true); @@ -387,7 +380,6 @@ * @param ec editing context to get the object into * @param key key value under which the object is registered * @param handleUnsuccessfulQueryForKey if false, a cache miss returns null rather than fetching - * @return */ public T objectForKey(EOEditingContext ec, Object key, boolean handleUnsuccessfulQueryForKey) { ERXExpiringCache<Object, EORecord<T>> cache = cache(); Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchResultCache.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchResultCache.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchResultCache.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -48,7 +48,6 @@ * Returns an array of EOs that where cached for the given fetch specification or null. * @param ec * @param fs - * @return */ public NSArray<? extends EOEnterpriseObject> objectsForFetchSpecification(EODatabaseContext dbc, EOEditingContext ec, EOFetchSpecification fs) { String identifier = ERXFetchSpecification.identifierForFetchSpec(fs); @@ -83,7 +82,6 @@ /** * Returns a list of entities that should not be cached. - * @return */ protected NSArray<String> excludedEntities() { return NSArray.EmptyArray; @@ -92,7 +90,6 @@ /** * Returns the time the result should stay in the cache. Less or equal than zero means don't cache. * @param fs - * @return */ protected long cacheTime(NSArray eos, EOFetchSpecification fs) { if(fs.fetchesRawRows() || fs.refreshesRefetchedObjects()) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchSpecification.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchSpecification.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXFetchSpecification.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -76,7 +76,6 @@ /** * Sets a arbitrary value. - * @return */ public void setObjectForKey(Object value, String key) { _userInfo = _userInfo == null ? new NSMutableDictionary() : _userInfo; @@ -93,7 +92,6 @@ /** * Gets the user info. - * @return */ public NSDictionary userInfo() { return _userInfo == null ? NSDictionary.EmptyDictionary : _userInfo.immutableClone(); @@ -102,7 +100,6 @@ /** * Type-safe method to fetch objects for this fetch spec. * @param ec - * @return */ public NSArray<T> fetchObjects(EOEditingContext ec) { return ec.objectsWithFetchSpecification(this); @@ -111,7 +108,6 @@ /** * Type-safe method to fetch raw rows. * @param ec - * @return */ public NSArray<NSDictionary<String, Object>> fetchRawRows(EOEditingContext ec) { boolean old = fetchesRawRows(); @@ -129,7 +125,6 @@ /** * Collects all relevant attributes and the bindings and returns a key suitable for caching. - * @return */ public String identifier() { return identifierForFetchSpec(this); @@ -149,7 +144,6 @@ * @param <T> * @param fs * @param clazz - * @return */ public static <T extends EOEnterpriseObject> ERXFetchSpecification<T> fetchSpec(EOFetchSpecification fs, Class<T> clazz) { if (fs instanceof ERXFetchSpecification) { @@ -162,8 +156,6 @@ * Converts a normal fetch spec to an ERX one. * @param <T> * @param fs - * @param clazz - * @return */ public static <T extends EOEnterpriseObject> ERXFetchSpecification<T> fetchSpec(EOFetchSpecification fs) { if (fs instanceof ERXFetchSpecification) { @@ -175,7 +167,6 @@ /** * Helper to create a string from a qualifier. * @param q - * @return */ protected static String identifierForQualifier(EOQualifier q) { final StringBuilder sb = new StringBuilder(); @@ -223,7 +214,6 @@ /** * Builds an identifier for the given fetch spec which is suitable for caching. * @param fs - * @return */ public static String identifierForFetchSpec(EOFetchSpecification fs) { StringBuilder sb = new StringBuilder( identifierForQualifier(fs.qualifier())); Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXGroupingFetchSpecification.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXGroupingFetchSpecification.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXGroupingFetchSpecification.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -184,7 +184,6 @@ /** * Type-safe method to fetch the rows for this fetch spec. * @param ec - * @return */ public NSArray<T> fetchObjects(EOEditingContext ec) { NSArray oldKeyPaths = rawRowKeyPaths(); Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXModelGroup.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXModelGroup.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/eof/ERXModelGroup.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -959,7 +959,6 @@ * Returns whether the given model is listed as a prototype model in the properties. * * @param model - * @return */ public boolean isPrototypeModel (EOModel model) { if (_prototypeModelNames != null && model != null && _prototypeModelNames.containsObject(model.name())) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXDictionaryUtilities.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXDictionaryUtilities.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXDictionaryUtilities.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -101,7 +101,7 @@ /** * Creates a new dictionary with only the keys and objects in the array. The result is the objects for the - * intersection of key in the dictionary and the array. This is the opposite of dictionaryByRemovingFromDictionaryKeysInArray. + * intersection of keys in the dictionary and the array. This is the opposite of dictionaryByRemovingFromDictionaryKeysInArray. * * @param d dictionary to be pruned * @param a array of keys to be included @@ -309,7 +309,6 @@ * Encodes a dictionary into a string that can be used in a request uri. * @param dict dictionary with form values * @param separator optional value separator - * @return */ public static String queryStringForDictionary(NSDictionary<Object, Object> dict, String separator) { return queryStringForDictionary(dict, separator, WOMessage.defaultURLEncoding()); @@ -319,7 +318,6 @@ * Encodes a dictionary into a string that can be used in a request uri. * @param dict dictionary with form values * @param separator optional value separator - * @return */ public static String queryStringForDictionary(NSDictionary<Object, Object> dict, String separator, String encoding) { if (separator == null) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXExpiringCache.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXExpiringCache.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXExpiringCache.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -426,7 +426,6 @@ /** * Returns all keys. - * @return */ public synchronized NSArray<K> allKeys() { NSMutableArray<K> result = new NSMutableArray<K>(_backingDictionary.count()); Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXRuntimeUtilities.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXRuntimeUtilities.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXRuntimeUtilities.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -608,7 +608,6 @@ /** * Clear the interrupt flag for the thread. * @param thread - * @return */ public static synchronized String clearThreadInterrupt(Thread thread) { if(flags == null) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXStringUtilities.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXStringUtilities.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/foundation/ERXStringUtilities.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -730,7 +730,7 @@ * otherwise it will return the passed in * string. * @param s string to test - * @return "" if the string is null else the string + * @return the empty string if the string is null, else the string */ public static String emptyStringForNull(String s) { return s==null ? "" : s; @@ -1789,7 +1789,6 @@ /** * Utility to encode an URL without the try/catch. Throws an NSForwardException in the unlikely case that ERXMessageEncoding.defaultEncoding() can't be found. * @param string - * @return */ public static String urlEncode(String string) { try { @@ -1803,7 +1802,6 @@ /** * Utility to decode an URL without the try/catch. Throws an NSForwardException in the unlikely case that ERXMessageEncoding.defaultEncoding() can't be found. * @param string - * @return */ public static String urlDecode(String string) { try { @@ -1817,8 +1815,6 @@ /** * Utility to convert to UTF-8 bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found. * @param string string to convert - * @param encoding - * @return */ public static byte[] toUTF8Bytes(String string) { return toBytes(string, "UTF-8"); @@ -1828,7 +1824,6 @@ * Utility to convert to bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found. * @param string string to convert * @param encoding - * @return */ public static byte[] toBytes(String string, String encoding) { if(string == null) { @@ -1845,9 +1840,7 @@ /** * Utility to convert from UTF-8 bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found. - * @param string string to convert - * @param encoding - * @return + * @param bytes string to convert */ public static String fromUTF8Bytes(byte bytes[]) { return fromBytes(bytes, "UTF-8"); @@ -1855,9 +1848,8 @@ /** * Utility to convert from bytes without the try/catch. Throws an NSForwardException in the unlikely case that your encoding can't be found. - * @param string string to convert + * @param bytes string to convert * @param encoding - * @return */ public static String fromBytes(byte bytes[], String encoding) { if(bytes == null) { Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/jdbc/ERXSQLHelper.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/jdbc/ERXSQLHelper.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/jdbc/ERXSQLHelper.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -840,8 +840,6 @@ * * @param indexName * the name of the index to create - * @param expression - * the EOSQLExpression context * @param tableName the name of the containing table * @param columnNames * the list of column names to index on @@ -857,8 +855,6 @@ * * @param indexName * the name of the index to create - * @param expression - * the EOSQLExpression context * @param tableName the name of the containing table * @param columnIndexes * the list of columns to index on @@ -874,8 +870,6 @@ * * @param indexName * the name of the index to create - * @param expression - * the EOSQLExpression context * @param tableName the name of the containing table * @param columnNames * the list of column names to index on @@ -899,8 +893,6 @@ * * @param indexName * the name of the index to create - * @param expression - * the EOSQLExpression context * @param tableName the name of the containing table * @param columnIndexes * the list of columns to index on Modified: trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/qualifiers/IERXChainableQualifier.java =================================================================== --- trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/qualifiers/IERXChainableQualifier.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/Core/ERExtensions/Sources/er/extensions/qualifiers/IERXChainableQualifier.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -46,8 +46,6 @@ * the type of the array * @param array * the array to filter - * @param qualifier - * the qualifier to filter with * @return the filtered array */ public <T> NSArray<T> filtered(NSArray<T> array); @@ -58,8 +56,6 @@ * * @param array * the array to filter (in place) - * @param qualifier - * the qualifier to filter with */ public void filter(NSMutableArray<?> array); @@ -70,8 +66,6 @@ * the type of the array * @param array * the array to filter (in place) - * @param qualifier - * the qualifier to filter with * @return the first matching object or null */ public <T> T first(NSArray<T> array); @@ -83,8 +77,6 @@ * the type of the array * @param array * the array to filter (in place) - * @param qualifier - * the qualifier to filter with * @return one matching object or null * @throw IllegalStateException if more than one object matched */ @@ -97,8 +89,6 @@ * the type of the array * @param array * the array to filter (in place) - * @param qualifier - * the qualifier to filter with * @return one matching object * @throw IllegalStateException if more than one object matched * @throw NoSuchElementException if no objects matched Modified: trunk/Wonder/Frameworks/EOF/ERRest/Sources/er/rest/ERXRestRequestHandler.java =================================================================== --- trunk/Wonder/Frameworks/EOF/ERRest/Sources/er/rest/ERXRestRequestHandler.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/EOF/ERRest/Sources/er/rest/ERXRestRequestHandler.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -573,8 +573,6 @@ * * @param authenticationDelegate * the authentication delegate - * @param delegate - * the rest delegate * @param displayAllProperties * if true, by default all properties are eligible to be displayed (probably should only be true in * development, but it won't really hurt anything). Note that entity delegates will still control Modified: trunk/Wonder/Frameworks/PlugIns/DerbyPlugIn/Sources/com/webobjects/jdbcadaptor/DerbyPlugIn.java =================================================================== --- trunk/Wonder/Frameworks/PlugIns/DerbyPlugIn/Sources/com/webobjects/jdbcadaptor/DerbyPlugIn.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/PlugIns/DerbyPlugIn/Sources/com/webobjects/jdbcadaptor/DerbyPlugIn.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -282,8 +282,6 @@ * system that the jdbcInfo which has been bundled into the plugin is * acceptable to use in place of actually going to the database and getting * it. - * - * @return */ protected boolean shouldUseBundledJdbcInfo() { boolean shouldUseBundledJdbcInfo = false; Modified: trunk/Wonder/Frameworks/PlugIns/FrontBasePlugIn/Sources/com/webobjects/jdbcadaptor/_FrontBasePlugIn.java =================================================================== --- trunk/Wonder/Frameworks/PlugIns/FrontBasePlugIn/Sources/com/webobjects/jdbcadaptor/_FrontBasePlugIn.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/PlugIns/FrontBasePlugIn/Sources/com/webobjects/jdbcadaptor/_FrontBasePlugIn.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -102,8 +102,6 @@ * This method returns true if the connection URL for the database has a special flag on it which indicates to the * system that the jdbcInfo which has been bundled into the plugin is acceptable to use in place of actually going * to the database and getting it. - * - * @return */ protected boolean shouldUseBundledJdbcInfo() { boolean shouldUseBundledJdbcInfo = false; Modified: trunk/Wonder/Frameworks/PlugIns/PostgresqlPlugIn/Sources/com/webobjects/jdbcadaptor/PostgresqlPlugIn.java =================================================================== --- trunk/Wonder/Frameworks/PlugIns/PostgresqlPlugIn/Sources/com/webobjects/jdbcadaptor/PostgresqlPlugIn.java 2008-11-26 23:21:49 UTC (rev 8675) +++ trunk/Wonder/Frameworks/PlugIns/PostgresqlPlugIn/Sources/com/webobjects/jdbcadaptor/PostgresqlPlugIn.java 2008-11-27 02:52:14 UTC (rev 8676) @@ -67,7 +67,6 @@ * system that the jdbcInfo which has been bundled into the * plugin is acceptable to use in place of actually going to * the database and getting it. - * @return */ protected boolean shouldUseBundledJdbcInfo() { boolean shouldUseBundledJdbcInfo = false; This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |