New top story on Hacker News: Show HN: I generated API documentation for all Java packages

Show HN: I generated API documentation for all Java packages
6 by martin_dd | 0 comments on Hacker News.
Hi HN! I'm excited to share a project I've been working on for the past year: Docland. It is an API documentation browser that generates documentation on demand (through compilation, not LLMs) for Java packages. Instead of relying on Javadoc, the built-in doc generator, I created the engine from scratch to give the documentations a modern look, build fast search indexes, and enable link resolution to other packages. I built Docland because I constantly found it frustrating to locate and view API definitions when programming. You'd have to Google the function/class name, skip all the SEO articles, find the page you want, yet the documentation might be poorly formatted or does not support searching. So I thought it would be really cool to create a documentation site dedicated for programming languages and libraries, so that you can find the docs all in one place with a uniform look. Docland currently only supports Java, but more programming languages can be supported thanks to its modular architecture. Please try it out and let me know what you think! Also, the process of building Docland was extremely fun and challenging. I'm happy to share about that too. Thank you! Martin

Comments

Post a Comment

Popular posts from this blog

Northeastern US braces for foot of snow during first days of December

Image
The second part of a double-barreled storm is forecast to unload heavy snow and create difficult travel over a large part of the northeastern United States, including some major cities from Sunday to Monday.A winterlike storm from the Midwest will move in this weekend, then hand off to a new coastal storm that strengthens by Monday.Accumulating snow is forecast to occur in Boston; Hartford, Connecticut; New York City and even to some extent around the Trenton, New Jersey, and Philadelphia area from the storm. The heaviest snow, on the order of 6-12 inches is forecast from the northeastern corner of Pennsylvania to central Massachusetts and southwestern New Hampshire. However, pockets of 12-18 inches are in store for the Catskills and Berkshires, where an AccuWeather Local StormMax™ of 24 inches is expected.Heavy snow is in store for much of the Hudson, Mohawk and Connecticut river valleys with a few inches as far south as parts of the Delaware and Lehigh valleys.Part of the storm will
Read more

North Korea test fires two missiles month before deadline for US to respond on talks

Image
North Korea fired two "unidentified projectiles" on Thursday, Seoul said, as nuclear talks between Pyongyang and Washington remain deadlocked. The projectiles were fired eastwards from South Hamgyong province and came down in the Sea of Japan, also known as the East Sea, South Korea's Joint Chiefs of Staff (JCS) said. They added that the launch, the latest in a series by Pyongyang, was carried out at 16:59 pm local time - or the early hours on the east coast of the United States, during Thanksgiving, one of the country's biggest annual holidays. It was also one day short of the two-year anniversary of the North's first test of its Hwasong-15 intercontinental ballistic missile, which analysts say is capable of reaching the entire US mainland. Pyongyang is banned from firing ballistic missiles under UN Security Council resolutions, and Prime Minister Shinzo Abe said that Thursday's launch was the latest in a series of violations.  "North Korea's repeate
Read more

Democratic debate winners and losers: Elizabeth Warren triumphs while Beto O'Rourke flounders

Image
The Democrat Party 2020 presidential election debate in Miami was the major chance for the many of the candidates involved to pitch themselves to a national audience.The 10 candidates on the stage, with another 10 debating tomorrow, had around 10 minutes maximum to make sure they stood out. Some triumphed, some failed.The candidates were: Cory Booker, Beto O'Rourke, Elizabeth Warren, Julián Castro, Amy Klobuchar, Tulsi Gabbard, Tim Ryan, John Delaney, Bill de Blasio, and Jay Inslee.Ms Warren is the frontrunner of those names when it comes to the national polls, with Mr Booker and Mr O'Rourke the other candidates with solid name recognition.Here are our winners and losers from the two hours of questions, impassioned statements and squabbles. WinnersElizabeth WarrenThe senator from Massachusetts was the person to beat in the debate and would have expected the other candidates to come after her. Getting through the two hours without a major slip or spat would have been enough.But
Read more