Get Even More Visitors To Your Blog, Upgrade To A Business Listing >>

javadoc-cleanup 1.3.7 Released (minor bug fixes)

Posted on Oct 5 I just released javadoc-cleanup 1.3.7, a Github Action to Post-Process Javadoc-Generated Documentation in GitHub Actions Before Deploying to the Web. The javadoc-cleanup GitHub Action is implemented in Python, and its functionality includes inserting a viewport meta tag if not present (pre-Java 16); generating and inserting canonical URLs into the head of Javadoc pages; an option to insert a user-defined block into the head of Javadoc generated pages, which I use in my projects to insert my website's favicon and a referrer policy; and a few other things.This release, javadoc-cleanup 1.3.7, primarily consists of minor bug fixes not likely encountered by users, all related to regular expressions used to check for things within Javadoc generated HTML, such as to check for presence of a viewport meta tag, or to check if a page was generated by Javadoc to begin with. The existing regular expressions worked correctly for all cases based upon actual Javadoc generated pages, but could fail for other validly formatted tags they were designed to detect. Bugs revealed by warning messages generated by Python 3.12 about the regular expressions that were not generated by Python 3.11 and earlier.Please consider starring javadoc-cleanup's GitHub repository:Check out all of our GitHub Actions: https://actions.cicirello.org/The javadoc-cleanup GitHub action is a utility to tidy up javadocs prior to deployment toan API documentation website, assumed hosted on GitHub Pages. It performs the followingfunctions:For more information, see my earlier post about javadoc-cleanup here on DEV, as well as its webpage. The javadoc-cleanup GitHub Action enables creating mobile-friendly and SEO ready documentation sites by post-processing javadocs in GitHub Actions. It is a utility to tidy up javadocs prior to deployment to an API documentation website, including improving mobile browsing experience, inserting canonical links, and anything else you want to insert into the head of each page. If you'd like to see some examples of how this action can be used within GitHub Workflows, then also check out another earlier DEV post:Follow me here on DEV and on GitHub:Or visit my website: Vincent A. Cicirello - Professor of Computer Science at Stockton University - is aresearcher in artificial intelligence, evolutionary computation, swarm intelligence,and computational intelligence, with a Ph.D. in Robotics from Carnegie MellonUniversity. He is an ACM Senior Member, IEEE Senior Member, AAAI Life Member,EAI Distinguished Member, and SIAM Member. Templates let you quickly answer FAQs or store snippets for re-use. Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment's permalink. Hide child comments as well Confirm For further actions, you may consider blocking this person and/or reporting abuse Jacky (Anh Le) - Sep 13 Jakub Andrzejewski - Oct 2 Raj Maharjan - Oct 3 Kaike Castro - Sep 13 Once suspended, cicirello will not be able to comment or publish posts until their suspension is removed. Once unsuspended, cicirello will be able to comment and publish posts again. Once unpublished, all posts by cicirello will become hidden and only accessible to themselves. If cicirello is not suspended, they can still re-publish their posts from their dashboard. Note: Once unpublished, this post will become invisible to the public and only accessible to Vincent A. Cicirello. They can still re-publish the post if they are not suspended. Thanks for keeping DEV Community safe. Here is what you can do to flag cicirello: cicirello consistently posts content that violates DEV Community's code of conduct because it is harassing, offensive or spammy. Unflagging cicirello will restore default visibility to their posts. DEV Community — A constructive and inclusive social network for software developers. With you every step of your journey. Built on Forem — the open source software that powers DEV and other inclusive communities.Made with love and Ruby on Rails. DEV Community © 2016 - 2023. We're a place where coders share, stay up-to-date and grow their careers.



This post first appeared on VedVyas Articles, please read the originial post: here

Share the post

javadoc-cleanup 1.3.7 Released (minor bug fixes)

×

Subscribe to Vedvyas Articles

Get updates delivered right to your inbox!

Thank you for your subscription

×