Saturday, March 15, 2014

Libgdx Extensions Javadocs or How to Extract Javadocs from Source Jars

Hi,

A lot of open source projects like Libgdx package sources in jars. So how do you generate Javadocs with the Javadoc command directly from a jar file?

You can't. You have to extract the jar first.

Specifically for Libgdx, extensions are not documented in the http://libgdx.badlogicgames.com/nightlies/docs/api/ online Javadoc.

One alternative is to just attach the source jars with whatever editor you are using, such as Eclipse. For Eclipse, right click on the project -> build path -> configure build path. Then there should be a window similar to this:



Click the plus symbol next to the jar, then double click source attachment. A dialog box will appear to allow you to attach the source jar.





However, this does not solve the original problem. You want an HTML Javadoc Index.html file to look at, possibly on a multi-monitor setup. No problem. Create a small script to extract the jar files and build the Javadoc for you (or use Ant or build tool of your choosing).

The below is specific to Libgdx but could be modified for any open source project with source jars. Download the Libgdx nightly here http://libgdx.badlogicgames.com/nightlies/

1.

touch ./extensions-javadoc


2.
chmod 755 ./extensions-javadoc
 
3. Open extensions-javadoc with your favourite text editor and paste below

#!/bin/bash

mkdir extension-sources
cd extension-sources
jar -xvf ./../extensions/gdx-audio/sources/gdx-audio-sources.jar
jar -xvf ./../extensions/gdx-bullet/sources/gdx-bullet-sources.jar
jar -xvf ./../extensions/gdx-controllers/sources/gdx-controllers-android-sources.jar
jar -xvf ./../extensions/gdx-controllers/sources/gdx-controllers-desktop-sources.jar
jar -xvf ./../extensions/gdx-controllers/sources/gdx-controllers-gwt-sources.jar
jar -xvf ./../extensions/gdx-controllers/sources/gdx-controllers-sources.jar
jar -xvf ./../extensions/gdx-freetype/sources/gdx-freetype-sources.jar
jar -xvf ./../extensions/gdx-image/sources/gdx-image-sources.jar
jar -xvf ./../extensions/gdx-jnigen/sources/gdx-jnigen-sources.jar
jar -xvf ./../extensions/gdx-tiled-preprocessor/sources/gdx-tiled-preprocessor-sources.jar
jar -xvf ./../extensions/gdx-tools/sources/gdx-tools-sources.jar

javadoc -d ./../docs-extensions -sourcepath ./ -subpackages com
 


4. Save and run script
./extensions-javadoc
Rejoice at your newly available HTML Javadocs!

41 comments:

  1. Thank you for sharing this informative post.MyAssignmenthelp.com is giving assignment help to students.we are already trusted by thousands of students who struggle to write their academic papers and also by those students who simply want English homework help canada to save their time and make life easy.Are you on the lookout for flawless Online English Homework help in Canada? This blog will greet you with reliable insights. A case study requires investigating a specific issue of the Help with english homework, examining the alternative solutions, and proposing the most effective solution by using suitable supporting evidence.

    ReplyDelete
  2. Do you know the genuine possible behind the non-working of HP Printer? Well, you do not feel worse as you come in the strong grip of Printer office. This is the invalidate condition as there lies some break for the Printer Is Offline Windows 10. No matter how many times you jump on the print command using the file menu of word file and other concerning page, the printer cannot yield the quality result. It is the best option that you would have to come on our third party professional as you are firm minded to eradicate the maximum problems. Feel free to contact our team.
    how to get printer online
    how do i get my printer online
    HP Solution Center
    HP Solution Center Windows 10
    Error Printing
    Printer Error
    hp printer driver is unavailable
    printer driver unavailable
    driver is unavailable printer

    ReplyDelete

  3. Have you purchased a wireless HP Printer, so looking to connect or set up a wireless printer to wifi? To Setup HP Printer, go to the printer's control panel, then click or touch the wireless network and then wireless setup wizard will display some list of wireless networks in your location, for further information read our article.

    ReplyDelete

  4. Learn to change outlook password as it is a simple process you can do after login your Microsoft outlook account. Follow the article and change the outlook password in minutes.

    ReplyDelete
  5. Market Analysis Assignment Help is the easiest solution to access a professional’s help to finish the market analysis assignment before the due dates. Sometimes, it gets hard to get enough time to concentrate on studies and complete market analysis papers properly.

    ReplyDelete
  6. The global Medical Devices Market is categorized into orthopedic devices, cardiovascular devices, diagnostic imaging, in vitro diagnostic medical devices (IVD), minimally invasive surgical devices (MIS), wound management, diabetes care, ophthalmic devices, dental, nephrology, and others. Various end users covered in the report are hospitals & ambulatory surgical centers, clinics, and others. Geographically, the market is segmented into five major regions, which are North America, Europe, Asia Pacific, Latin America, and the Middle East & Africa. The regions are further categorized into countries.

    ReplyDelete
  7. Are you looking for accounting software to upscale the accounts section of your business? then you must check one of the best accounting software that you might come across at Quickbooks Online Login

    Showtime Anytime is one of the online video streaming platforms Like Amazon prime video, which is exclusively available in the USA. To know more interesting details about Showtime Anytime you can visit us at showtimeanytime.com/activate

    Pluto tv is one of the ad-supported video streaming platforms online for free in the United States of America. Wanna know more in detail about how to Activate pluto Tv just us visit pluto.tv/activate.

    ReplyDelete
  8. This comment has been removed by the author.

    ReplyDelete
  9. That is a huge number of students. Are they from the same country or different countries? I also want your math assignment help . I want to perform in my assignments and since this is what you have been doing for years, I believe you are the right person for me. Let me know how much you charge for your math homework help services.

    ReplyDelete
  10. This comment has been removed by the author.

    ReplyDelete
  11. In their spa motto, they welcome every client with no race specification, to cultivate themselves to a stress-free vacation experience assignment help

    ReplyDelete
  12. Hello. I am looking for SPSS homework help urgently from your end. Please tell me how I can acquire your services at the earliest. Also, let me know if you provide any discounts so that I can acquire more services in no time. Also, let me know if you offer SAS Assignment help online. I live in London so I want to acquire online services from you. Thank you so much for your time and consideration. I am waiting for your response.

    ReplyDelete
  13. Gotoassignmenthelp is team of leading professional writers for Assignment Help Writing Services to students all around the world. Contact us today for Best Canada Assignment Help at very affordable price. Under GotoAssignmentHelp we provide many types of help to the students. We are the most reliable assignment helpers. We have gained our specialization after spending most of our times in making ourselves perfect.

    ReplyDelete
  14. Excellent article. Keep posting information like this on your site... traveling to turkey from Canada for tourism or trade should purchase an e-visa prior to entering the country. Canadians can also obtain a visa for turkey from Canada in some international airports. If you plan to study or work in Turkey, you must obtain a visa at a Turkish visa portal before arriving in Turkey.

    ReplyDelete
  15. incredible post I must tell and do a lot for the data. The instruction is undoubtedly the best sticky on this valuable topic.. You can read online kenya entry requirements through kenya e-visa.

    ReplyDelete

  16. Very nice blog, a debt of gratitude is in order for sharing such delightful data with us. Thank you. Check LMU post utme past questions pdf download

    ReplyDelete
  17. What a great explanation in yours posts.. International travelers who wish to travel to Azerbaijan for tourism and business purpose need to apply for Azerbaijan electronic visa through e visa application and must check the Azerbaijan entry restrictions before coming to Azerbaijan.

    ReplyDelete
  18. The word “FAMILY” plays a vital role in every human life because family comes as a top priority; we are well aware of that. Like a tree has its root, stem, branches, leaf, flowers, the same as the family tree has its structure like grandparents, parents, child, and it keeps continuing from generation to generation. “Family tree,” yeah, just two simple words, but these two words are highly important for everyone’s life.

    ReplyDelete
  19. Thanks for this article. I appreciate it, now that you can apply for an India tourist visa for a long term, the whole process is straightforward and online.

    ReplyDelete
  20. Are you looking for an assignment writing service? Get the academic writing help from the assignment helper with chat support.
    English homework help

    online assignment help

    ReplyDelete
  21. Maintaining the proper records and documents for all the transactions carried out had become highly necessary for every business and the customers. The success of every company lies in the quality of the regional information it possesses. It is imperative to the companies carrying globally to make sure that they have the required technical writing service to help them succeed in the global market.
    kindle conversion services
    flash to html5 conversion

    ReplyDelete
  22. The most fruitful way of learning is grasping content through a video. At acadecraft, we create Professional Explainer Videos professional explainer videos at affordable prices. Our explainer videos are extensively informative, visually-appealing, and in accordance with the latest technology. Moreover, our professional explainer videos are proven to bring positive learning outcomes and customer satisfaction.

    ReplyDelete
  23. Struggling with your academic tasks and spending day and night to precisely finish it off, in order to achieve your desired marks in your academic session? Seeking for helping hands and professional advice online to manage your academic problems because of the busy or hectic schedule? Browse millions of academic solutions, assessments and Q&A by means of Assignment Help comprehensive guidance this hour and excel with the best scores!

    ReplyDelete
  24. One of the main aims of financial auditing is to provide accurate accounts of a company's financial business transactions. Usually the academic jobs related to auditing make anxieties in the minds of students and for that reason they are more susceptible to making mistakes. Are you too one of them and are feeling afraid with incomplete academic tasks in auditing? Don’t worry! Auditing Assignment Help has a global reach that you can contact from anywhere in the world and make yourself assured of getting top-notch marks easily!!

    ReplyDelete
  25. Are you in the dire need of professionals for tackling your tough engineering related assessments and homework jobs? Now, there’s no need of troubling yourself and feeling low. By approaching towards Engineering Assignment Help reference guide, you will not just be able to score top-notch grades, as well as, you will be able to learn how to handle your academic jobs on your own.

    ReplyDelete
  26. International economics is basically a specialized branch, which mainly studies how trade takes place between the countries. However, the incomplete academic jobs related to this course curriculum will always get on the nerves of students. At this point, it is recommended to avail the personalized International Economics Assignment Help reference in a time bound manner, in order to attain higher grades!

    ReplyDelete
  27. In order to accurately finish off your academic jobs related to consumer behavior, students must have a sound understanding of the course curriculum, good writing skills, and enough time to research on it. Due to lack of these, students are unable to precisely tackle their assessment jobs and look for professional help. Are you too one of them, going through this situation, then come towards Theory of Consumer Behavior Assignment Help to make your academic grades and performance outshine!!

    ReplyDelete
  28. Gambling is prohibited for individuals under 18 years of age and can lead to addiction. If might have} an issue with gambling or are experiencing any addiction, please contact variety of the} gambling centers to provide you with adequate and timely help. In 1908, many bell machines emerged and could be be} found in many of} eating places, bars, barbershops, bordellos, and others. Visits from a few of the the} most influential names within the leisure trade helped this space 온라인 카지노 develop and develop even faster. At that time, it had reached one of the highest ranges throughout the nation. Please enter the phone quantity which is registered in your Wildz account and we'll ship a confirmation code to change your password.

    ReplyDelete
  29. Outstanding and beautiful post. This is such an amazing resource that you are providing, and it is free. And I've got something else for you that's really interesting. assignment service egypt will help you complete your assignments on time and at a very low cost. If you would want his assignment assistance, please click here. You should like this, I hope.

    ReplyDelete
  30. There are thousands of agencies offering Rajasthan Tour Package, some of them are not good at offering benefits and some are offering benefits but they are overpriced. If you are also facing the same issue, come and visit Go Rajasthan Travel to know about everything in detail. Our team of experts will make you understand everything.

    ReplyDelete
  31. Nice article; I was surfing net and fortunately came across this site and found very interesting stuff here. It’s really fun to read. I enjoyed a lot. Thanks for sharing this wonderful information. Thank you for sharing. ncat nd admission form out

    ReplyDelete
  32. Are you one of those students, who are striving to precisely finish up your assessments and homework jobs associated with HND course? Then we suggest you take a sigh of relief and enjoy your academic life to the fullest as it never comes back again. Avail the HND Assignment Help reference guide and meet up all your academic requirements. We assure you that you will definitely feel the presence of intellect around and will surely obtain soaring grades and reach academic heights!!

    ReplyDelete
  33. Explore the healing traditions of South India with a rejuvenating South Indian Ayurveda Tour at Lumiere Holidays. Immerse yourself in the serenity of Ayurveda amidst stunning landscapes. This tour offers an authentic wellness experience, bringing harmony to your body and soul in the heart of South India.

    ReplyDelete
  34. Completing HNC assignments and homework with perfection within or before the submission date can be quite challenging for most of the students. The variation in the course curriculum makes it tough for students to get apt knowledge and understanding. At this point, it is always recommended to get in touch with professionals, who are quite knowledgeable in this course. With HNC Assignment Help reference guide, dealing with academic tasks will become a cakewalk. It is always assured that you will attain stellar grades in your curriculum for sure!

    ReplyDelete
  35. Completing the BTEC assignments is definitely not a cake walk for students, as this requires patience, time, and effort. If you are one among those scholars struggling to finish academic tasks with quality and on time, then you need assistance from a professional hand. Don’t take too much of the burden of your academic tasks on your shoulders. Please sit back, relax, and grab the best deals and offers from industry best professional BTEC Assignment Help tutors. Say goodbye to stress and deadlines and handle your academic dilemmas hassle-free!!

    ReplyDelete
  36. India Holiday Packages offer diverse experiences, from spiritual journeys to cultural escapades. Explore ancient wonders with Varanasi Holiday Packages, immersing in the city's sacred aura. For devout pilgrims, the Chardham Tour unveils Uttarakhand's divine beauty. Tailored to various preferences, these packages promise unforgettable journeys through India's rich tapestry of traditions and landscapes.

    ReplyDelete
  37. Every post in your blog unravels a captivating intellectual expedition, offering a well of insightful musings. Your ability to convey intricate ideas with clarity is truly laudable. Anxiously awaiting deeper insights in your digital sanctuary.

    ReplyDelete
  38. I'm quite taken with the template and theme of this site. It's wonderfully simple yet highly effective. Achieving that delicate balance between usability and visual appeal isn't easy, but you've managed it admirably. Moreover, the blog loads remarkably fast on Chrome, making it truly exceptional.

    ReplyDelete
  39. More than just a means of acquiring degrees or certificates, online learning platforms cultivate a mindset of lifelong learning. They instill the value of curiosity and adaptability, essential traits in an ever-evolving world. Read more about 10 Best Online Learning Platforms That Student Must Know for Better Learning.

    ReplyDelete
  40. What a fantastic blog! The content is not only informative but also incredibly engaging. Each post is meticulously crafted, showcasing the author's expertise and dedication to delivering value to readers. I find myself eagerly anticipating new updates, knowing I'll be treated to thought-provoking insights and expert analysis. This blog has become an indispensable resource for anyone seeking enlightenment and enrichment.

    ReplyDelete