Generate the appropriate help document based on the source code of the Open project

Source: Internet
Author: User

There are more and more open-source projects on the market now, but while projects are open source, many of the relevant documents require our money to buy them. If you do not purchase, we will not be able to obtain the corresponding Help document (PS: Here with struts2.2.1.1 as an example of demonstration )?

Let's teach you how to use source code to generate help documents:

1. Use MyEclipse to create a new project and put struts ' source code into it, at which point the org under the SRC folder. The package at the beginning is an error, but don't worry, keep looking down:

2. All jar packages in the struts2.2.1.1. jar file (except for Struts2.core) are introduced into the established project:


3. After performing the 2nd step, most of the errors are resolved, but there are two remaining problems: HttpRequest and HttpResponse are missing references, so the 3rd step is to solve the problem:

Using the same reference method as the 2nd step, the Jsp-appi.jar and Servlet-api.jar two jar packages in Tomcat are introduced into the project and saved, and the entire project will no longer prompt for the error message. With everything in place, we can start generating work:

4. After all the errors are resolved, we start the work of the build phase:


After selecting "Generate Javadoc", make the following selections in the dialog box that pops up:

When all is done, click "Finish" to view the information in the Console tab, which will render:


After the information in the Console tab is complete, copy the downloaded Jd2chm.exe application into the same folder as the generated document and run the cmd Window command:


Between this command run, there will be a minute or so of time the computer will not have any reaction, so at this stage we must wait patiently. After the command window has been executed, there will be a corresponding message, and our folder page will appear such a file, which is the help document we need:


So we are done, as long as there is open source project code, we can generate the corresponding Help document, so mom no longer worry about my study!


Copyright NOTICE: This article for Bo Master original article, without Bo Master permission not reproduced.

Generate the appropriate help document based on the source code of the Open project

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.