Javadoc: Fixed @inheritDoc to be {@inheritDoc}

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5965 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-07-24 17:32:48 +00:00 · 2007-06-14 18:18:53 +00:00
parent bfaedb95ca
commit e670eabfad
15 changed files with 47 additions and 47 deletions
--- a/source/java/org/alfresco/repo/admin/registry/RegistryServiceImpl.java
+++ b/source/java/org/alfresco/repo/admin/registry/RegistryServiceImpl.java
@@ -269,7 +269,7 @@ public class RegistryServiceImpl implements RegistryService
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void addProperty(RegistryKey key, Serializable value)
    {
--- a/source/java/org/alfresco/repo/avm/AVMNodeService.java
+++ b/source/java/org/alfresco/repo/avm/AVMNodeService.java
@@ -1031,7 +1031,7 @@ public class AVMNodeService extends AbstractNodeServiceImpl implements NodeServi
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void removeProperty(NodeRef nodeRef, QName qname) throws InvalidNodeRefException
    {
--- a/source/java/org/alfresco/repo/content/AbstractContentReader.java
+++ b/source/java/org/alfresco/repo/content/AbstractContentReader.java
@@ -238,7 +238,7 @@ public abstract class AbstractContentReader extends AbstractContentAccessor impl
    
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public FileChannel getFileChannel() throws ContentIOException
    {
--- a/source/java/org/alfresco/repo/content/AbstractContentWriter.java
+++ b/source/java/org/alfresco/repo/content/AbstractContentWriter.java
@@ -254,7 +254,7 @@ public abstract class AbstractContentWriter extends AbstractContentAccessor impl
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public FileChannel getFileChannel(boolean truncate) throws ContentIOException
    {
--- a/source/java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java
+++ b/source/java/org/alfresco/repo/content/AbstractWritableContentStoreTest.java
@@ -65,7 +65,7 @@ public abstract class AbstractWritableContentStoreTest extends AbstractReadOnlyC
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * <p>
     * This implementation creates some content in the store and returns the new content URL.
     */
--- a/source/java/org/alfresco/repo/content/metadata/AbstractMappingMetadataExtracter.java
+++ b/source/java/org/alfresco/repo/content/metadata/AbstractMappingMetadataExtracter.java
@@ -159,7 +159,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * @see #setSupportedMimetypes(Collection)
     */
@@ -458,7 +458,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac
        initialized = true;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public long getExtractionTime()
    {
        return extractionTime;
@@ -484,7 +484,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public final boolean extract(ContentReader reader, Map<QName, Serializable> destination) throws ContentIOException
    {
@@ -492,7 +492,7 @@ abstract public class AbstractMappingMetadataExtracter implements MetadataExtrac
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public final boolean extract(
            ContentReader reader,
--- a/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java
+++ b/source/java/org/alfresco/repo/content/metadata/AbstractMetadataExtracter.java
@@ -127,7 +127,7 @@ abstract public class AbstractMetadataExtracter implements MetadataExtracter
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * @return      Returns <tt>true</tt> if the {@link #getReliability(String) reliability}
     *              is greater than 0
@@ -163,7 +163,7 @@ abstract public class AbstractMetadataExtracter implements MetadataExtracter
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public boolean extract(ContentReader reader, Map<QName, Serializable> destination) throws ContentIOException
    {
@@ -202,7 +202,7 @@ abstract public class AbstractMetadataExtracter implements MetadataExtracter
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * @param overwritePolicy       ignored
     * @param propertyMapping       ignored
--- a/source/java/org/alfresco/repo/model/ml/EditionServiceImpl.java
+++ b/source/java/org/alfresco/repo/model/ml/EditionServiceImpl.java
@@ -77,7 +77,7 @@ public class EditionServiceImpl implements EditionService
                        ContentModel.PROP_LOCALE
                    };

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public NodeRef createEdition(NodeRef startingTranslationNodeRef, Map<String, Serializable> versionProperties)
    {
        if (nodeService.hasAspect(startingTranslationNodeRef, ContentModel.ASPECT_MULTILINGUAL_DOCUMENT))
@@ -185,7 +185,7 @@ public class EditionServiceImpl implements EditionService
        return startNode;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public VersionHistory getEditions(NodeRef mlContainer)
    {
        VersionHistory editionHistory = null;
@@ -215,7 +215,7 @@ public class EditionServiceImpl implements EditionService
        return editionHistory;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public Map<QName, Serializable> getVersionedMetadatas(Version version)
    {
        NodeRef frozenNodeRef = version.getFrozenStateNodeRef();
@@ -245,7 +245,7 @@ public class EditionServiceImpl implements EditionService
        }
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public List<VersionHistory> getVersionedTranslations(Version mlContainerEdition)
    {
        // Ensure that the given version is an Edition of an mlContainer
--- a/source/java/org/alfresco/repo/model/ml/MultilingualContentServiceImpl.java
+++ b/source/java/org/alfresco/repo/model/ml/MultilingualContentServiceImpl.java
@@ -323,7 +323,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        return isPivot;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public boolean isTranslation(NodeRef contentNodeRef)
    {
        if (!nodeService.hasAspect(contentNodeRef, ContentModel.ASPECT_MULTILINGUAL_DOCUMENT))
@@ -355,7 +355,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        }
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public void makeTranslation(NodeRef contentNodeRef, Locale locale)
    {
        NodeRef mlContainerNodeRef = makeTranslationImpl(null, contentNodeRef, locale);
@@ -369,7 +369,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        }
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public void unmakeTranslation(NodeRef translationNodeRef)
    {
        // Get the container
@@ -423,7 +423,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        }
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public void addTranslation(NodeRef newTranslationNodeRef, NodeRef translationOfNodeRef, Locale locale)
    {
        // Get the container
@@ -450,7 +450,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        }
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public NodeRef getTranslationContainer(NodeRef translationNodeRef)
    {
        NodeRef mlContainerNodeRef = getOrCreateMLContainer(translationNodeRef, false);
@@ -458,7 +458,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        return mlContainerNodeRef;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public Map<Locale, NodeRef> getTranslations(NodeRef translationOfNodeRef)
    {
        NodeRef mlContainerNodeRef = null;
@@ -499,7 +499,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        return nodeRefsByLocale;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public NodeRef getTranslationForLocale(NodeRef translationNodeRef, Locale locale)
    {
        // Get all the translations
@@ -530,7 +530,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        return nearestNodeRef;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public List<Locale> getMissingTranslations(NodeRef localizedNodeRef, boolean addThisNodeLocale)
    {
        List<Locale> foundLocales   = new ArrayList<Locale>(getTranslations(localizedNodeRef).keySet());
@@ -583,7 +583,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
        return missingLocales;
    }

-    /** @inheritDoc */
+    /** {@inheritDoc} */
    public NodeRef getPivotTranslation(NodeRef nodeRef)
    {
        Locale containerLocale = null;
@@ -617,7 +617,7 @@ public class MultilingualContentServiceImpl implements MultilingualContentServic
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public NodeRef addEmptyTranslation(NodeRef translationOfNodeRef, String name, Locale locale)
    {
--- a/source/java/org/alfresco/repo/module/AbstractModuleComponent.java
+++ b/source/java/org/alfresco/repo/module/AbstractModuleComponent.java
@@ -155,7 +155,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public String getModuleId()
    {
@@ -171,7 +171,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public String getName()
    {
@@ -202,7 +202,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public String getDescription()
    {
@@ -221,7 +221,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public VersionNumber getSinceVersionNumber()
    {
@@ -237,7 +237,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public VersionNumber getAppliesFromVersionNumber()
    {
@@ -254,7 +254,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public VersionNumber getAppliesToVersionNumber()
    {
@@ -271,7 +271,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public List<ModuleComponent> getDependsOn()
    {
@@ -287,7 +287,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * @return Returns <tt>true</tt> always.  Override as required.
     */
@@ -325,7 +325,7 @@ public abstract class AbstractModuleComponent implements ModuleComponent, BeanNa
    protected abstract void executeInternal() throws Throwable;

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * @see #executeInternal() the abstract method to be implemented by subclasses
     */
--- a/source/java/org/alfresco/repo/module/ModuleComponentHelper.java
+++ b/source/java/org/alfresco/repo/module/ModuleComponentHelper.java
@@ -189,7 +189,7 @@ public class ModuleComponentHelper
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public synchronized void startModules()
    {
--- a/source/java/org/alfresco/repo/module/ModuleServiceImpl.java
+++ b/source/java/org/alfresco/repo/module/ModuleServiceImpl.java
@@ -123,7 +123,7 @@ public class ModuleServiceImpl implements ModuleService
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * @see ModuleComponentHelper#startModules()
     */
@@ -133,7 +133,7 @@ public class ModuleServiceImpl implements ModuleService
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public ModuleDetails getModule(String moduleId)
    {
@@ -145,7 +145,7 @@ public class ModuleServiceImpl implements ModuleService
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public List<ModuleDetails> getAllModules()
    {
--- a/source/java/org/alfresco/repo/node/db/hibernate/HibernateNodeDaoServiceImpl.java
+++ b/source/java/org/alfresco/repo/node/db/hibernate/HibernateNodeDaoServiceImpl.java
@@ -1043,7 +1043,7 @@ public class HibernateNodeDaoServiceImpl extends HibernateDaoSupport implements
    }
    
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * This includes a check to ensuret that only root nodes don't have primary parents
     */
@@ -1088,7 +1088,7 @@ public class HibernateNodeDaoServiceImpl extends HibernateDaoSupport implements

    private Set<NodeRef> warnedDuplicateParents = new HashSet<NodeRef>(3);
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     * 
     * This method includes a check for multiple primary parent associations.
     * The check doesn't fail but will warn (once per instance) of the occurence of
--- a/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java
+++ b/source/java/org/alfresco/repo/security/authentication/AbstractAuthenticationComponent.java
@@ -124,7 +124,7 @@ public abstract class AbstractAuthenticationComponent implements AuthenticationC
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public Authentication setCurrentAuthentication(Authentication authentication)
    {
--- a/source/java/org/alfresco/repo/transaction/TransactionListenerAdapter.java
+++ b/source/java/org/alfresco/repo/transaction/TransactionListenerAdapter.java
@@ -32,35 +32,35 @@ package org.alfresco.repo.transaction;
 public abstract class TransactionListenerAdapter implements TransactionListener
 {
    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void flush()
    {
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void beforeCommit(boolean readOnly)
    {
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void beforeCompletion()
    {
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void afterCommit()
    {
    }

    /**
-     * @inheritDoc
+     * {@inheritDoc}
     */
    public void afterRollback()
    {