SAK-41072 Cleanup help tool (unused files/JavaDoc). (sakaiproject#6382)

* EhCache isn’t needed here.

EhCache isn't used in this project and it's config file can be removed
and the pom.xml section can be removed.

* Fix for broken JavaDoc.

Correct JavaDoc references that got broken in a rename of packages.

* Remove unused files

These files aren't used in the current codebase.

* Move GlossaryEntryBean.

* Add dependency so validation of beans can happen.

This allows validation of the spring beans.xml file.

* Remove commented out dependencies.

help/help-component-shared/pom.xml

@@ -32,20 +32,5 @@
       <groupId>org.sakaiproject</groupId>
       <artifactId>sakai-help-api</artifactId>
     </dependency>
-<!--org.sakaiprojectsakai-component-api${sakai.version}-->
-<!--org.sakaiprojectsakai-tool-api${sakai.version}-->
   </dependencies>
-  <build>
-    <resources>
-      <resource>
-        <directory>src/java</directory>
-        <includes>
-          <include>**/*.xml</include>
-        </includes>
-        <excludes>
-          <exclude>ehcache.xml</exclude>
-        </excludes>
-      </resource>
-    </resources>
-  </build>
 </project>

help/help-component/src/java/org/sakaiproject/component/app/help/DefaultGlossary.java

@@ -32,7 +32,6 @@
 
 import org.sakaiproject.api.app.help.Glossary;
 import org.sakaiproject.api.app.help.GlossaryEntry;
-import org.sakaiproject.component.app.help.model.GlossaryEntryBean;
 
 /**
  * default glossary

help/help-component-shared/src/java/org/sakaiproject/component/app/help/model/GlossaryEntryBean.java → help/help-component/src/java/org/sakaiproject/component/app/help/GlossaryEntryBean.java

@@ -19,7 +19,7 @@
  *
  **********************************************************************************/
 
-package org.sakaiproject.component.app.help.model;
+package org.sakaiproject.component.app.help;
 
 import org.sakaiproject.api.app.help.GlossaryEntry;
 

help/help-component/src/java/org/sakaiproject/component/app/help/HelpManagerImpl.java

@@ -171,7 +171,7 @@ public ServerConfigurationService getServerConfigurationService()
 	}
 
 	/**
-	 * @see org.sakaiproject.api.app.help.HelpManager#setServerConfigurationService(org.sakaiproject.service.framework.config.ServerConfigurationService)
+	 * @see org.sakaiproject.api.app.help.HelpManager#setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService)
 	 */
 	public void setServerConfigurationService(ServerConfigurationService s)
 	{
@@ -229,7 +229,7 @@ public Set<Resource> getResources(Long contextId)
 
 	/**
 	 * Store resource
-	 * @see org.sakaiproject.api.app.help.HelpManager#storeResource(org.sakaiproject.api.help.Entity)
+	 * @see org.sakaiproject.api.app.help.HelpManager#storeResource(org.sakaiproject.api.app.help.Resource)
 	 */
 	public void storeResource(Resource resource)
 	{
@@ -272,7 +272,7 @@ public Source getSource(Long id)
 	}
 
 	/**
-	 * @see org.sakaiproject.api.app.help.HelpManager#storeSource(org.sakaiproject.api.help.Source)
+	 * @see org.sakaiproject.api.app.help.HelpManager#storeSource(org.sakaiproject.api.app.help.Source)
 	 */
 	public void storeSource(Source source)
 	{
@@ -307,7 +307,7 @@ public Context getContext(Long id)
 	}
 
 	/**
-	 * @see org.sakaiproject.api.app.help.HelpManager#storeContext(org.sakaiproject.api.help.Context)
+	 * @see org.sakaiproject.api.app.help.HelpManager#storeContext(org.sakaiproject.api.app.help.Context)
 	 */
 	public void storeContext(Context context)
 	{
@@ -380,7 +380,7 @@ public TableOfContents getTableOfContents()
 	}
 
 	/**
-	 * @see org.sakaiproject.api.app.help.HelpManager#setTableOfContents(org.sakaiproject.api.help.TableOfContents)
+	 * @see org.sakaiproject.api.app.help.HelpManager#setTableOfContents(org.sakaiproject.api.app.help.TableOfContents)
 	 */
 	public void setTableOfContents(TableOfContents toc)
 	{
@@ -681,7 +681,7 @@ public void setGlossary(Glossary glossary)
 	}
 
 	/**
-	 * @see org.sakaiproject.api.app.help.HelpManager#storeCategory(org.sakaiproject.api.help.Category)
+	 * @see org.sakaiproject.api.app.help.HelpManager#storeCategory(org.sakaiproject.api.app.help.Category)
 	 */
 	public void storeCategory(Category category)
 	{
@@ -980,8 +980,6 @@ public Object doInTransaction(TransactionStatus status)
 
 	/**
 	 * Returns the user locale
-	 * @param prefLocales
-	 *            The prefLocales to set.
 	 */
 	private Locale getSelectedLocale() {
 
@@ -1060,7 +1058,7 @@ private void registerHelpContent()
 	/**
 	 * register external help content
 	 * build document from external reg file
-	 * @param externalHelpReg
+	 * @param helpFile The helpfile to register
 	 */
 	public void registerExternalHelpContent(String helpFile)
 	{

help/help/pom.xml

@@ -19,7 +19,12 @@
   <properties>
     <deploy.target>shared</deploy.target>
   </properties>
-  <dependencies />
+  <dependencies>
+    <dependency>
+      <groupId>org.sakaiproject</groupId>
+      <artifactId>sakai-comp-shared-help</artifactId>
+    </dependency>
+  </dependencies>
   <build>
     <resources>
       <resource>