Skip to content
This repository has been archived by the owner on Jan 21, 2024. It is now read-only.

Commit

Permalink
fixes javadoc issues in test projects
Browse files Browse the repository at this point in the history
  • Loading branch information
prb112 committed Nov 5, 2015
1 parent b1574b9 commit a88cf1e
Show file tree
Hide file tree
Showing 49 changed files with 97 additions and 100 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@

/**
* Class that manages container extension points. If an application wishes to add a container to the
* OpenSocial implementation they first need to implement {@link com.ibm.sbt.opensocial.domino.container.ContainerExtPoint}.
* OpenSocial implementation they first need to implement link com.ibm.sbt.opensocial.domino.container.ContainerExtPoint.
* Applications can contribute information about their containers via two mechanisms.
*
* <ol>
* <li>Via the OSGi extension point com.ibm.sbt.opensocial.domino.container.</li>
* <li>Via {@link #registerContainer(ContainerExtPoint)}. When using {@link #registerContainer(ContainerExtPoint)}
* make sure you also call {@link #unregisterContainer(ContainerExtPoint)} when the app is terminated.</li>
* <li>Via link #registerContainer(ContainerExtPoint). When using link #registerContainer(ContainerExtPoint)
* make sure you also call link #unregisterContainer(ContainerExtPoint) when the app is terminated.</li>
* </ol>
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import com.google.inject.Singleton;

/**
* Provides the {@link com.ibm.sbt.opensocial.domino.container.ContatinerExtPointManager}.
* Provides the link com.ibm.sbt.opensocial.domino.container.ContatinerExtPointManager.
*
*/
@Singleton
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public class DominoOAuth2Request implements OAuth2Request {
private final Logger log;

/**
* @param fetcherConfig
* @param tokenStore
* configuration options for the fetcher
* @param fetcher
* fetcher to use for actually making requests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* query parameters.
*
* Parameters in the request to this servlet should be keyed by
* {@link AbstractSecurityToken.Keys}
* link AbstractSecurityToken.Keys
*
* The response, if there was no error, will be JSON of the form
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ public void setPublished(Date published) {
}

/**
* @param _repository the _repository to set
* @param repository the _repository to set
*/
public void setRepository(String repository) {
this._repository = repository;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ public interface IFileType {

/**
* Add the URL parameters specific to this service.
* @param url
* @return
* @param map
*/
public void addUrlParameters(Map<String, String> map, int index, int blockSize) throws ClientServicesException;

Expand Down Expand Up @@ -85,11 +84,10 @@ public interface IFileType {
*
* @param svc
* the service where the files are to be read from
* @param accessor TODO
* @param accessor
* @param params
* a list of parameters that are to be added to the URL
* @return
* a list of FileEntry objects, whereby each item in the List maps to a file stored within the service
* @return a list of FileEntry objects, whereby each item in the List maps to a file stored within the service
* @throws ClientServicesException
*
*/
Expand All @@ -113,7 +111,7 @@ public interface IFileType {
public void uploadFile(Endpoint authBean, File serverFile, FileServiceData dataSource, HashMap<String, String> params) throws CloneNotSupportedException;

/**
* @return
* @return {boolean}
*/
public boolean useFolders();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public class DropboxFiles extends AbstractType {
* https://api-content.dropbox.com/<VERSION>/files/dropbox
* @param path
* path to the file to be downloaded
* @return
* @return {String}
*/
public String buildHref(String path, Endpoint bean) {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ public String getFunctionName() {
* the JavaScript execution context (global variables, function...)
* @param args
* the arguments passed to the function
* @params _this the "this" object when the method is called as a "this" member
* @param _this the "this" object when the method is called as a "this" member
*/
@Override
public FBSValue call(IExecutionContext context, FBSValueVector args, FBSObject _this)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ public class SmartCloudProfileService extends ClientService {

/**
* @param endpoint
* @param serviceUrl
*/
public SmartCloudProfileService(Endpoint endpoint) {
super(endpoint);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public String getTitle() {
}

/**
* @param set the title
* @param title set the title
*/
public void setTitle(String title) {
this.title = title;
Expand All @@ -157,7 +157,7 @@ public String getContent() {
}

/**
* @param set the content
* @param content set the content
*/
public void setContent(String content) {
this.content = content;
Expand All @@ -172,7 +172,7 @@ public Date getTweetDate() {
}

/**
* @param set the publishedDate
* @param tweetDate set the publishedDate
*/
@Deprecated
public void setTweetDate(Date tweetDate) {
Expand All @@ -187,7 +187,7 @@ public String getPublishedDate() {
}

/**
* @param set the publishedDate
* @param publishedDate set the publishedDate
*/
public void setPublishedDate(String publishedDate) {
this.publishedDate = publishedDate;
Expand All @@ -201,7 +201,7 @@ public String getUpdatedDate() {
}

/**
* @param set the updatedDate
* @param updatedDate set the updatedDate
*/
public void setUpdatedDate(String updatedDate) {
this.updatedDate = updatedDate;
Expand All @@ -215,7 +215,7 @@ public String getImage() {
}

/**
* @param set the image
* @param image set the image
*/
public void setImage(String image) {
this.image = image;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* @author mkataria
* @author mwallace
*
* @date Jan 10, 2013
* @since Jan 10, 2013
*/
public class PlaygroundEnvironment extends TestEnvironment {
private String baseUrl;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* @author mkataria
* @author mwallace
*
* @date Jan 10, 2013
* @since Jan 10, 2013
*/
public class SbtWebEnvironment extends TestEnvironment {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ public void addSnippetParam(String key, String value) {
* invoked
*
* @param key
* @param value
* @param values
*/
public void addSnippetParam(String key, String[] values) {
snippetParams.put(key, StringUtil.concatStrings(values, ',', true));
Expand Down Expand Up @@ -405,7 +405,7 @@ public void quitDriver() {
/**
* Launch the specified snippet
*
* @param snippetId
* @param baseTest
*
* @return true if the snippet could be launched
*/
Expand Down Expand Up @@ -645,8 +645,8 @@ protected void handleOAuth20(BaseTest baseTest) {
/**
* Detect what type of authentication is being used
*
* @param form
*
* @param baseTest
* @param loginForm
* @return {AuthType}
*/
public AuthType detectAuthType(BaseTest baseTest, WebElement loginForm) {
Expand Down Expand Up @@ -1127,7 +1127,7 @@ public boolean isLibrary(String lib) {
/**
* tests the version identifier of the current library
*
* @param lib
* @param version
* a library version, using non dotted format (i.e. 182 for
* jquery 1.8.2, 143 for dojo 1.4.3)
* @return true if the environment is using the specified library
Expand All @@ -1143,7 +1143,7 @@ public boolean isLibraryVersion(String version) {
/**
* tests the version identifier of the current library
*
* @param lib
* @param version
* a library version, using non dotted format (i.e. 182 for
* jquery 1.8.2, 143 for dojo 1.4.3)
* @return {boolean}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* @author mkataria
* @author mwallace
*
* @date Jan 14, 2013
* @since Jan 14, 2013
*/
public class TestEnvironmentFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ public static JavaSnippet getJavaSnippet(String snippetName) {
/**
* Get a RootNode object which allows JavaSnippets to be searched and manipulated.
*
* @param context
* @return {RootNode} of the local JavaSnippets.
*/
public static RootNode getJavaSnippets(){
Expand Down Expand Up @@ -145,7 +144,7 @@ private static RootNode getSnippets( NodeFactory nodeFactory, String path){
/**
* A method which will, for a given root folder and NodeFactory, return the corresponding RootNode of Snippets.
*
* @param {VFSFile} file
* @param file
* @param nodeFactory The NodeFactory corresponding to the snippet type.
* @return RootNode of snippets, which allows search and manipulation of snippets.
* @throws IOException
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ protected boolean checkGrid(GridResultPage resultPage, boolean hasPager, boolean
}

/**
* @param resultPage
* @param gridPage
* @param rows
* @return {boolean}
*/
protected boolean checkPager(GridResultPage gridPage,String[] rows) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ public void deleteActivity() throws ClientServicesException{
* @param content
* @param tags
* @param retry
* @return
* @return {Community} the created community
*/
public Community createCommunity(String title, String type, String content, ArrayList<String> tags, boolean retry) {
Community community = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/**
* @author mwallace
*
* @date 5 Mar 2013
* @since 5 Mar 2013
*/
public class BaseJavaServiceTest extends BaseServiceTest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

/**
* @author Francis
* @date 24 May 2013
* @since 24 May 2013
*/
public class BaseSampleFrameworkTest extends BaseTest {

Expand All @@ -35,7 +35,6 @@ public BaseSampleFrameworkTest() {
/**
* Launch the Sample Framework
*
* @param snippetId
* @return the result page
*/
protected SampleFrameworkResultPage launchSampleFramework() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* @author mwallace
*
* @date 5 Mar 2013
* @since 5 Mar 2013
*/
public class BaseServiceTest extends BaseTest {

Expand All @@ -44,7 +44,7 @@ public class BaseServiceTest extends BaseTest {

/**
*
* @return
* @return {boolean}
*/
protected boolean checkNoError(String snippetId, boolean allowEmpty) {
String text = executeSnippet(snippetId);
Expand All @@ -54,15 +54,15 @@ protected boolean checkNoError(String snippetId, boolean allowEmpty) {

/**
*
* @return
* @return {boolean}
*/
protected boolean checkNoError(String snippetId) {
return checkNoError(snippetId, false);
}

/**
*
* @return
* @return {boolean}
*/
protected boolean checkExpected(String snippetId, String expected) {
String text = executeSnippet(snippetId);
Expand Down Expand Up @@ -128,8 +128,8 @@ public String getExpectedErrorMsg() {

/**
* @param snippetId
* @return
*/
* @return {JavaScriptPreviewPage}
*/
protected JavaScriptPreviewPage executeSnippet1(String snippetId) {
ResultPage resultPage = launchSnippet(snippetId, authType, 0);
JavaScriptPreviewPage previewPage = new JavaScriptPreviewPage(resultPage);
Expand All @@ -139,7 +139,7 @@ protected JavaScriptPreviewPage executeSnippet1(String snippetId) {

/**
* @param snippetId
* @return
* @return {String}
*/
protected String executeSnippet(String snippetId) {
ResultPage resultPage = launchSnippet(snippetId, authType);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public void doQuit() {
*
* </p>
*
* @return
* @return {boolean}
*/
protected boolean isEnvironmentValid() {
return true;
Expand Down Expand Up @@ -273,7 +273,7 @@ public void addSnippetParam(String key, String value) {
* invoked
*
* @param key
* @param value
* @param values
*/
public void addSnippetParam(String key, String[] values) {
snippetParams.put(key, StringUtil.concatStrings(values, ',', true));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

/**
* @author Francis
* @date 16 Jul 2013
* @since 16 Jul 2013
*/
public class BaseViewTest extends BaseApiTest {
/**
Expand Down
Loading

0 comments on commit a88cf1e

Please sign in to comment.