diff --git a/docs/pages/pmd/devdocs/writing_documentation.md b/docs/pages/pmd/devdocs/writing_documentation.md index da41c98748..37d7145707 100644 --- a/docs/pages/pmd/devdocs/writing_documentation.md +++ b/docs/pages/pmd/devdocs/writing_documentation.md @@ -203,3 +203,8 @@ public class Foo { public void bar() { System.out.println("x"); } } ``` + +## Checking for dead links + +`mvn verify -pl pmd-doc`. This only checks links within the site. HTTP links can be checked +by specifying `-Dpmd.doc.checkExternalLinks=true` on the command line. diff --git a/docs/pages/pmd/projectdocs/trivia/news.md b/docs/pages/pmd/projectdocs/trivia/news.md index ddbd4f3129..5c7b3c0e6e 100644 --- a/docs/pages/pmd/projectdocs/trivia/news.md +++ b/docs/pages/pmd/projectdocs/trivia/news.md @@ -12,17 +12,9 @@ author: Tom Copeland * May 2008 - Romain Pelisse's article in LinuxMagazin: [An introduction to PMD (in French)](http://connect.ed-diamond.com/GNU-Linux-Magazine/GLMF-105/Verifier-votre-code-Java-avec-PMD) -* May 2008 - Alan Berg's article on - [Free Software Magazine](http://freesoftwaremagazine.com/articles/destroy_annoying_bugs_part_1/) - discusses FindBugs, PMD, and TFTP. - * July 2007 - Ryan Slobojan's article on [InfoQ](http://www.infoq.com/news/2007/07/pmd) discusses the PMD 4.0 release. -* October 2006 -Alan Berg's article "Light On Java Code" in - [Software Testing and Performance Magazine [link broken]](http://www.stpmag.com/issues/stp-2006-10.pdf) - discusses static code analysis using FindBugs and PMD. - * July 2006 - Paul Duvall's article "Automation for the people: Continuous Inspection" on [developerWorks](http://www-128.ibm.com/developerworks/java/library/j-ap08016/index.html) discusses CPD. @@ -76,9 +68,6 @@ author: Tom Copeland * November 2003 - [JavaWorld: "Bug patrol"](http://www.javaworld.com/javaworld/jw-11-2003/jw-1121-quality.html) - Various code inspection tools -* [JJGuidelines - Java and J2EE Conventions, Guidelines and Best Practices [link broken]](https://jjguidelines.dev.java.net/index.html) - - a project sponsored by the Belgian government to codify coding practices; uses PMD as the compliance checking utility - * June 2003 - [Software Development Times [link broken]](http://www.sdtimes.com/news/080/story15.htm) - PMD is embedded in QStudio. diff --git a/docs/pages/pmd/userdocs/installation.md b/docs/pages/pmd/userdocs/installation.md index aaf85766f1..31734de6a7 100644 --- a/docs/pages/pmd/userdocs/installation.md +++ b/docs/pages/pmd/userdocs/installation.md @@ -15,7 +15,7 @@ sidebar: pmd_sidebar * A zip archiver, e.g.: * For Windows: [Winzip](http://winzip.com) or the free [7-zip](http://www.7-zip.org/) - * For Linux / Unix: [InfoZip](http://www.info-zip.org/pub/infozip/) + * For Linux / Unix: [InfoZip](http://infozip.sourceforge.net/) {% include note.html content="For executing the Designer (./run.sh designer) using [OpenJDK](http://jdk.java.net) or Java 11, you need additionally [OpenJFX](http://jdk.java.net). Download it, extract it and set the environment variable JAVAFX_HOME." %} diff --git a/docs/pages/pmd/userdocs/tools/tools.md b/docs/pages/pmd/userdocs/tools/tools.md index 37b9e32943..b8427311fe 100644 --- a/docs/pages/pmd/userdocs/tools/tools.md +++ b/docs/pages/pmd/userdocs/tools/tools.md @@ -167,32 +167,6 @@ being used by a getResourceAsStream() call to load it out of the PMD jar files. the [PMDExtension jar file](http://sourceforge.net/projects/pmd/files/pmd-bluej/pmd-bluej-1.0/) and place it in your `bluej/lib/extensions/` directory. - -### Code Guide - -Here's how to set up PMD with Omnicore's CodeGuide: - -* Download the PMD zip file from [here](http://sourceforge.net/projects/pmd/files/pmd/) -* Unpack the zip file to your local disk. I put it in /Applications/ -* Add the following tool to CodeGuide (Tools->Configure Tools->New): - * Name: PMD - * Kind: Tool for directories - * Executable: /Applications/pmd-bin-{{pmd.site.version}}/bin/run.sh - * Arguments: pmd -d $DIRECTORY_PATH$ -f emacs $USER_ARGUMENTS$ - -Now you can right click on a source directory, select the PMD tool and a dialog box will appear. -Type in the name of a rule set (e.g. unusedcode). PMD is then executed on the directory you -selected with the rule set you specified. Since CodeGuide understands the emacs syntax you can -click on the file name and CodeGuide will jump to that file and line number. - -Note: I set this up on Mac OS X. It should work on other unix variations just the same. -Of course you need to change the "Executable" setting above to where your PMD is installed. -On Windows you need to use the pmd.bat file instead of pmd.sh. - -If you haven't heard of CodeGuide before, [check it out](http://www.omnicore.com/). -It's a great IDE. - - ### Eclipse To install the PMD plugin for Eclipse: diff --git a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/DeadLinksChecker.java b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/DeadLinksChecker.java index e5e9a39029..2069dc1927 100644 --- a/pmd-doc/src/main/java/net/sourceforge/pmd/docs/DeadLinksChecker.java +++ b/pmd-doc/src/main/java/net/sourceforge/pmd/docs/DeadLinksChecker.java @@ -173,8 +173,6 @@ public class DeadLinksChecker { executorService.shutdown(); - // all appenders have been pushed - System.out.println("Scanned " + scannedFiles + " files for dead links."); System.out.println(" Found " + foundExternalLinks + " external links, " + checkedExternalLinks + " of those where checked.");