1683 lines
46 KiB
HTML
1683 lines
46 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="description" content="">
|
|
<meta name="keywords" content=" ">
|
|
<title>Main Landing Page | PMD Source Code Analyzer</title>
|
|
<link rel="stylesheet" href="css/syntax.css">
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
|
|
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
|
|
<link rel="stylesheet" href="css/modern-business.css">
|
|
<link rel="stylesheet" href="css/lavish-bootstrap.css">
|
|
<link rel="stylesheet" href="css/customstyles.css">
|
|
<link rel="stylesheet" href="css/theme-blue.css">
|
|
<link rel="stylesheet" href="css/pmd-customstyles.css">
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
|
|
<script src="js/jquery.navgoco.min.js"></script>
|
|
|
|
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
|
|
<script src="js/toc.js"></script>
|
|
<script src="js/customscripts.js"></script>
|
|
|
|
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
|
|
<link rel="icon" href="images/favicon.ico" type="image/x-icon">
|
|
|
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
|
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
|
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<link rel="alternate" type="application/rss+xml" title="" href="https://pmd.github.io/pmd/feed.xml">
|
|
|
|
<script>
|
|
$(document).ready(function() {
|
|
// Initialize navgoco with default options
|
|
$("#mysidebar").navgoco({
|
|
caretHtml: '',
|
|
accordion: true,
|
|
openClass: 'active', // open
|
|
save: false, // leave false or nav highlighting doesn't work right
|
|
cookie: {
|
|
name: 'navgoco',
|
|
expires: false,
|
|
path: '/'
|
|
},
|
|
slide: {
|
|
duration: 400,
|
|
easing: 'swing'
|
|
}
|
|
});
|
|
|
|
$("#collapseAll").click(function(e) {
|
|
e.preventDefault();
|
|
$("#mysidebar").navgoco('toggle', false);
|
|
});
|
|
|
|
$("#expandAll").click(function(e) {
|
|
e.preventDefault();
|
|
$("#mysidebar").navgoco('toggle', true);
|
|
});
|
|
|
|
});
|
|
|
|
</script>
|
|
<script>
|
|
$(function () {
|
|
$('[data-toggle="tooltip"]').tooltip()
|
|
})
|
|
</script>
|
|
<script>
|
|
$(document).ready(function() {
|
|
$("#tg-sb-link").click(function() {
|
|
$("#tg-sb-sidebar").toggle();
|
|
$("#tg-sb-content").toggleClass('col-md-9');
|
|
$("#tg-sb-content").toggleClass('col-md-12');
|
|
$("#tg-sb-icon").toggleClass('fa-toggle-on');
|
|
$("#tg-sb-icon").toggleClass('fa-toggle-off');
|
|
});
|
|
});
|
|
</script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<!-- Content is offset by the height of the topnav bar. -->
|
|
<!-- There's already a padding-top rule in modern-business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
|
|
<div id="topbar-content-offset">
|
|
<!-- Navigation -->
|
|
<nav class="navbar navbar-inverse navbar-fixed-top">
|
|
<div class="container topnavlinks">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="fa fa-home fa-lg navbar-brand" href="index.html"> <span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<!-- toggle sidebar button -->
|
|
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
|
|
<!-- entries without drop-downs appear here -->
|
|
|
|
|
|
|
|
<li><a href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
|
|
|
|
|
|
|
|
<li><a href="https://github.com/pmd/pmd" target="_blank">Fork us on github</a></li>
|
|
|
|
|
|
|
|
<!-- entries with drop-downs appear here -->
|
|
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
|
|
|
|
|
|
<!--comment out this block if you want to hide search-->
|
|
<li>
|
|
<!--start search-->
|
|
<div id="search-demo-container">
|
|
<input type="text" id="search-input" placeholder="search...">
|
|
<ul id="results-container"></ul>
|
|
</div>
|
|
<script src="js/jekyll-search.js" type="text/javascript"></script>
|
|
<script type="text/javascript">
|
|
SimpleJekyllSearch.init({
|
|
searchInput: document.getElementById('search-input'),
|
|
resultsContainer: document.getElementById('results-container'),
|
|
dataSource: 'search.json',
|
|
searchResultTemplate: '<li><a href="{url}" title="Main Landing Page">{title}</a></li>',
|
|
noResultsText: 'No results found.',
|
|
limit: 10,
|
|
fuzzy: true,
|
|
})
|
|
</script>
|
|
<!--end search-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- /.container -->
|
|
</nav>
|
|
|
|
<!-- Page Content -->
|
|
<div class="container-toc-wrapper">
|
|
<div class="container">
|
|
<div class="col-lg-12"> </div>
|
|
<!-- Content Row -->
|
|
<div class="row">
|
|
|
|
|
|
<!-- Sidebar Column -->
|
|
<div class="col-md-3" id="tg-sb-sidebar">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul id="mysidebar" class="nav">
|
|
<li class="sidebarTitle">PMD 6.50.0-SNAPSHOT</li>
|
|
<div class="sidebarTitleDate">Release date: 30-September-2022</div>
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="#">About</a>
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="index.html">Home</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_release_notes.html">Release notes</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_next_major_development.html">PMD 7.0.0 development</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_about_help.html">Getting help</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="#">User Documentation</a>
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_best_practices.html">Best practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_suppressing_warnings.html">Suppressing warnings</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_incremental_analysis.html">Incremental analysis</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_cli_reference.html">PMD CLI reference</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_report_formats.html">PMD Report formats</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">CPD reference</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_cpd.html">Copy-paste detection</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_cpd_report_formats.html">CPD Report formats</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Extending PMD</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_writing_rules_intro.html">Introduction to writing rules</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_your_first_rule.html">Your first rule</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_writing_xpath_rules.html">XPath rules</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_writing_java_rules.html">Java rules</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_designer_reference.html">Rule designer reference</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_defining_properties.html">Defining rule properties</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_metrics_howto.html">Using and defining code metrics</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_rule_guidelines.html">Rule guidelines</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_extending_testing.html">Testing your rules</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Tools / Integrations</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_tools_maven.html">Maven PMD Plugin</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_tools_gradle.html">Gradle</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_tools_ant.html">Ant</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_tools_java_api.html">PMD Java API</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_tools_ci.html">CI integrations</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_userdocs_tools.html">Other Tools / Integrations</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="#">Rule Reference</a>
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Apex Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_codestyle.html">Code Style</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_design.html">Design</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_documentation.html">Documentation</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_performance.html">Performance</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_apex_security.html">Security</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Ecmascript Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_ecmascript.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_ecmascript_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_ecmascript_codestyle.html">Code Style</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_ecmascript_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">HTML Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_html.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_html_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Java Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_codestyle.html">Code Style</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_design.html">Design</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_documentation.html">Documentation</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_multithreading.html">Multithreading</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_performance.html">Performance</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_java_security.html">Security</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Java Server Pages Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_jsp.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_jsp_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_jsp_codestyle.html">Code Style</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_jsp_design.html">Design</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_jsp_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_jsp_security.html">Security</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Maven POM Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_pom.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_pom_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Modelica Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_modelica.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_modelica_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">PLSQL Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_plsql.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_plsql_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_plsql_codestyle.html">Code Style</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_plsql_design.html">Design</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_plsql_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Salesforce VisualForce Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vf.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vf_security.html">Security</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">VM Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm_design.html">Design</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">XML Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_xml.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_xml_errorprone.html">Error Prone</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">XSL Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_xsl.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_xsl_codestyle.html">Code Style</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_xsl_performance.html">Performance</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="#">Language Specific Documentation</a>
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_jsp.html">JSP Support</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Java Support</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_java.html">Java Versions</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_java_metrics_index.html">Java Code Metrics</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_apex_metrics_index.html">Apex code metrics</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_plsql.html">PLSQL</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_visualforce.html">Visualforce</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_xml.html">XML and XML dialects</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_html.html">HTML</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_gherkin.html">Gherkin</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="#">Developer Documentation</a>
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_development.html">Developer resources</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_writing_documentation.html">Writing documentation</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_roadmap.html">Roadmap</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_how_pmd_works.html">How PMD works</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_pmdtester.html">Pmdtester</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_rule_deprecation_policy.html">Rule Deprecation Policy</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Major contributions</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_major_rule_guidelines.html">Rule Guidelines</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_major_adding_new_language.html">Adding a new language</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_major_adding_new_metrics_framework.html">Adding metrics support to a language</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Experimental features</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_experimental_ast_dump.html">Creating (XML) dump of the AST</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
<a href="#">Project documentation</a>
|
|
|
|
<ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Trivia about PMD</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_trivia_news.html">PMD in the press</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_trivia_products.html">Products & books related to PMD</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_trivia_similarprojects.html">Similar projects</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_trivia_meaning.html">What does 'PMD' mean?</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_faq.html">FAQ</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="license.html">License</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_credits.html">Credits</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_release_notes_old.html">Old release notes</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Project management</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_committers_infrastructure.html">Infrastructure</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_committers_releasing.html">Release process</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_projectdocs_committers_merging_pull_requests.html">Merging pull requests</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li class="active"><a href="pmd_projectdocs_committers_main_landing_page.html">Main Landing page</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<!-- if you aren't using the accordion, uncomment this block:
|
|
<p class="external">
|
|
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
|
|
</p>
|
|
-->
|
|
</ul>
|
|
|
|
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
|
|
<script>$("li.active").parents('li').toggleClass("active");</script>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Content Column -->
|
|
<div class="col-md-9" id="tg-sb-content">
|
|
<header>
|
|
<div class="row">
|
|
<div class="col-lg-12">
|
|
<a href="./" role="button"
|
|
><i class="fa fa-home fa-lg"></i
|
|
></a>
|
|
» Main Landing Page
|
|
<a
|
|
target="_blank"
|
|
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/projectdocs/committers/main_landing_page.md"
|
|
class="pull-right"
|
|
role="button"
|
|
><i class="fa fa-github fa-lg"></i> Edit on GitHub</a
|
|
>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<hr />
|
|
</header>
|
|
|
|
|
|
<div class="post-header">
|
|
<h1 class="post-title-main">Main Landing Page</h1>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="post-content" data-github-edit-url="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/projectdocs/committers/main_landing_page.md">
|
|
|
|
|
|
<div id="inline-toc"><!-- empty, move TOC here when screen size too small --></div>
|
|
|
|
<p>The main homepage of PMD <a href="https://pmd.github.io">https://pmd.github.io</a> is hosted by Github Pages.</p>
|
|
|
|
<p>The repository is <a href="https://github.com/pmd/pmd.github.io">https://github.com/pmd/pmd.github.io</a>.</p>
|
|
|
|
<p>It uses <a href="https://jekyllrb.com/">Jekyll</a> to generate the static html pages. Jekyll is
|
|
executed by github for every push to the repository. Please note, that it takes some time
|
|
until Jekyll has been executed and due to caching, the homepage is not updated immediately.
|
|
It usually takes 15 minutes.</p>
|
|
|
|
<h2 id="contents">Contents</h2>
|
|
|
|
<ul>
|
|
<li>Main page - aka “Landing page”: <a href="https://pmd.github.io">https://pmd.github.io</a>
|
|
<ul>
|
|
<li>Layout: <a href="https://github.com/pmd/pmd.github.io/blob/master/_layouts/default.html">_layouts/default.html</a>.
|
|
It includes all the sub section, which can be found in the includes directory <a href="https://github.com/pmd/pmd.github.io/tree/master/_includes">_includes/</a></li>
|
|
<li>The latest PMD version is configured in <code class="language-plaintext highlighter-rouge">_config.yml</code> and the variables <code class="language-plaintext highlighter-rouge">site.pmd.latestVersion</code> are used
|
|
e.g. in <a href="https://github.com/pmd/pmd.github.io/blob/master/_includes/home.html">_includes/home.html</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Blog - aka “News”: <a href="https://pmd.github.io/news/">https://pmd.github.io/news/</a>
|
|
<ul>
|
|
<li>This is a section on main page. It shows the 5 latest news. See <a href="https://github.com/pmd/pmd.github.io/blob/master/_includes/news.html">_includes/news.html</a>.</li>
|
|
<li>There is also a sub page “news” which lists all news.
|
|
<ul>
|
|
<li>Layout: <a href="https://github.com/pmd/pmd.github.io/blob/master/_layouts/news.html">_layouts/news.html</a></li>
|
|
<li>Page (which is pretty empty): <a href="https://github.com/pmd/pmd.github.io/blob/master/news.html">news.html</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Documentation for the latest release: <a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a>
|
|
<ul>
|
|
<li>The PMD documentation of the latest release is simply copied as static html into the folder <a href="https://github.com/pmd/pmd.github.io/tree/master/latest">latest/</a>.
|
|
This makes the latest release documentation available under the stable URL
|
|
<a href="https://pmd.github.io/latest/">https://pmd.github.io/latest/</a>. This URL is also used for the <a href="https://github.com/pmd/pmd.github.io/blob/master/sitemap.xml">sitemap.xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Documentation for previous releases are still being kept under the folders <code class="language-plaintext highlighter-rouge">pmd-<version>/</code>.</li>
|
|
</ul>
|
|
|
|
<h2 id="building-the-page-locally">Building the page locally</h2>
|
|
|
|
<p>Since the repository contains the documentation for many old PMD releases, it is quite big. When executing
|
|
Jekyll to generate the site, it copies all the files to the folder <code class="language-plaintext highlighter-rouge">_site/</code> - and this can take a while.</p>
|
|
|
|
<p>In order to speed things up locally, consider to add <code class="language-plaintext highlighter-rouge">pmd-*</code> to the exclude patterns in <code class="language-plaintext highlighter-rouge">_config.yml</code>. See
|
|
also the comments in this file.</p>
|
|
|
|
<p>Then it is a matter of simply executing <code class="language-plaintext highlighter-rouge">bundle exec jekyll serve</code>. This will generate the site and host
|
|
it on localhost, so you can test the page at <a href="http://127.0.0.1:4000">http://127.0.0.1:4000</a>.</p>
|
|
|
|
<h2 id="updates-during-a-release">Updates during a release</h2>
|
|
|
|
<p>When creating a new PMD release, some content of the main page need to be updated as well.
|
|
This done as part of the <a href="pmd_projectdocs_committers_releasing.html">Release process</a>, but is
|
|
summarized here as well:</p>
|
|
|
|
<ul>
|
|
<li>The versions (e.g. <code class="language-plaintext highlighter-rouge">pmd.latestVersion</code>) needs to be updated in <code class="language-plaintext highlighter-rouge">_config.yml</code>
|
|
<ul>
|
|
<li>This is needed to generate the correct links and texts for the latest version on landing page</li>
|
|
</ul>
|
|
</li>
|
|
<li>The new PMD documentation needs to be copied to <code class="language-plaintext highlighter-rouge">/pmd-<version>/</code></li>
|
|
<li>Then this folder needs to copied to <code class="language-plaintext highlighter-rouge">/latest/</code>, actually replacing the old version.</li>
|
|
<li>A new blog post with release notes is added: <code class="language-plaintext highlighter-rouge">/_posts/YYYY-mm-dd-PMD-<version>.md</code></li>
|
|
<li>The sitemap <code class="language-plaintext highlighter-rouge">sitemap.xml</code> is regenerated</li>
|
|
</ul>
|
|
|
|
<p>Some of these steps are automated through <code class="language-plaintext highlighter-rouge">do-release.sh</code> (like blog post), some are manual steps
|
|
(updating the version in _config.yml) and other steps are done on the travis-ci-build (like
|
|
copying the new documentation).</p>
|
|
|
|
<h2 id="adding-a-new-blog-post">Adding a new blog post</h2>
|
|
|
|
<p>Adding a new blog post is as easy as:</p>
|
|
|
|
<ul>
|
|
<li>Creating a new file in the folder “_posts”: <code class="language-plaintext highlighter-rouge">/_posts/YYYY-mm-dd-<title>.md</code></li>
|
|
<li>The file name needs to fit this pattern. The date of the blog post is taken from the file name. The “<title>"
|
|
is used for the url.</title></li>
|
|
<li>The file is a markdown file starting with a frontmatter for jekyll. Just use this template for the new file:</li>
|
|
</ul>
|
|
|
|
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>---
|
|
layout: post
|
|
title: Title
|
|
---
|
|
|
|
Here comes the text
|
|
</code></pre></div></div>
|
|
|
|
<p>Once you commit and push it, Github will run Jekyll and update the page. The Jekyll templates take care that
|
|
the new post is recognized and added to the news section and also on the news subpage.</p>
|
|
|
|
|
|
<div class="tags">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<footer>
|
|
|
|
<hr />
|
|
<div>
|
|
This documentation is written in markdown. <br />
|
|
If there is something missing or can be improved, edit this page on
|
|
github and create a PR:
|
|
<a
|
|
target="_blank"
|
|
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/projectdocs/committers/main_landing_page.md"
|
|
role="button"
|
|
><i class="fa fa-github fa-lg"></i> Edit on GitHub</a
|
|
>
|
|
</div>
|
|
|
|
<hr />
|
|
<div class="row">
|
|
<div class="col-lg-12 footer">
|
|
©2022 PMD Open Source Project. All rights
|
|
reserved. <br />
|
|
<span>Page last updated:</span>
|
|
March 2020<br /> Site last generated: Sep 24, 2022 <br />
|
|
<p>
|
|
<img src="images/pmd-logo-small.png" alt="Company
|
|
logo"/>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
|
|
</div>
|
|
|
|
<!-- /.row -->
|
|
</div>
|
|
<!-- /.container -->
|
|
</div>
|
|
|
|
|
|
<!-- Sticky TOC column -->
|
|
<div class="toc-col">
|
|
<div id="toc"></div>
|
|
</div>
|
|
|
|
<!-- /.toc-container-wrapper -->
|
|
</div>
|
|
</div>
|
|
</body>
|
|
|
|
</html>
|