Skip to main content

Missing javaDoc

What is Javadoc?
Javadoc comment explains:
- what the class does, its author, and version.
- what the method does, its parameter, return value, and thrown exception.

Many times, instead of our source code, we share our JAR with the other team members and once they import our JAR into their project and start using it, they either:
- Don't see any Javadoc comments for the provided methods and they see this message on hover over- "Note: The Javadoc for this element could neither be found in the attached source nor the attached Javadoc."
- OR, they see partial comments as they do see the method params numbers but not the type, etc.

How to Fix this error?
1) Make sure that you have JavaDoc in place. To generate Java Doc in Eclipse: –
Select the “Generate JavaDoc” option from the Project menu
Specify the location for the JavaDoc file on your system
Select the project and then the packages/class for which you want to create the JavaDoc file.
Then click Next and then click Finish, it may take a while for Eclipse to execute the JavaDoc and finally, we'll end up with nice documentation with a folder named "doc".

2) Now attach this "doc" folder to apt. JAR:
Go to Project > Properties > Java Build Path > Libraries and Choose .jar file which has missing Javadoc>(You should see Javadoc location: (None)) Click Edit and Provide Javadoc location file and press OK.

Please do comment if you have any better way handy.


Labels:

Comments

Post a Comment

Popular posts from this blog

How to Unzip files in Selenium (Java)?

1) Using Java (Lengthy way) : Create a utility and use it:>> import java.io.BufferedOutputStream; import org.openqa.selenium.io.Zip; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.util.zip.ZipEntry; import java.util.zip.ZipInputStream;   public class UnzipUtil {     private static final int BUFFER_SIZE = 4096;     public void unzip (String zipFilePath, String destDirectory) throws IOException {         File destDir = new File(destDirectory);         if (!destDir.exists()) {             destDir.mkdir();         }         ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipFilePath));         ZipEntry entry = zipIn.getNextEntry();         // to iterates over entries in the zip folder         while (entry != null) {             String filePath = destDirectory + File.separator + entry.getName();             if (!entry.isDirectory()) {                 extractFile (zipIn, filePath);            
Post a Comment
Read more

Encode/Decode the variable/response using Postman itself

We get a lot of use cases where we may have to implement Base64 encoding and/or decoding while building our APIs. And, if you are wondering if it is possible to encode/decode the variable/response using Postman itself or how to encode/decode the token or password in postman and save it in a variable? To Base64 encode/decode, the quickest way is to use JavaScript methods btoa, atob: atob - It turns base64-encoded ASCII data back to binary. btoa - It turns binary data to base64-encoded ASCII. Sample code : var responseBody = pm.response.json(); var parsedPwd = JSON.parse(atob(responseBody.password)); // presuming password is in the payload pm.collectionVariables.set("password", parsedPwd);
Post a Comment
Read more

The use of Verbose attribute in testNG or POM.xml (maven-surefire-plugin)

At times, we see some weird behavior in your testNG execution and feel that the information displayed is insufficient and would like to see more details. At other times, the output on the console is too verbose and we may want to only see the errors. This is where a verbose attribute can help you- it is used to define the amount of logging to be performed on the console. The verbosity level is 0 to 10, where 10 is most detailed. Once you set it to 10, you'll see that console output will contain information regarding the tests, methods, and listeners, etc. <suite name="Suite" thread-count="5" verbose="10"> Note* You can specify -1 and this will put TestNG in debug mode. The default level is 0. Alternatively, you can set the verbose level through attribute in "maven-surefire-plugin" in pom.xml, as shown in the image. #testNG #automationTesting #verbose # #testAutomation
Post a Comment
Read more