[DOCUMENTATION] many broken links to Github on

[nils.ma...@gmail.com]

Hi,

on http://docs.sonarqube.org/display/PLUG/Custom+Rules+for+PHP are a lot of links that should lead to GitHub but result in a 404 reponse from GitHub.

List of broken links:

- Implement a rule

• define the rule name, key, tags, etc. with Java annotations. See example.

- Using PHPSubscriptionCheck

  For example, if you want to explore "if statement" nodes the method will return a list containing the element Tree#Kind#IF_STATEMENT. See example.

- Create issues

  The check context is provided by the PHPVisitorCheck and PHPSubscriptionCheck classes and accessible from PHPCheck#context method. See example.

- Testing checks

To test custom checks you can use PHPCheckTest#check() method. You should end each line with an issue with a comment in the following form (see example):

You can omit message if not required (like here). If for some reason this approach is inapplicable (e.g. there are several issues per line expected or the line already contains comment) you can pass the list of issues as third parameter.

Just the links:

• https://github.com/SonarSource/sonar-examples/blob/master/plugins/php-custom-rules/src/test/resources/checks/forbiddenFunctionUseCheck.js#L4
  
• https://github.com/SonarSource/sonar-examples/blob/master/plugins/php-custom-rules/src/test/resources/checks/forbiddenFunctionUseCheck.js#L1
  
• https://github.com/SonarSource/sonar-examples/blob/master/plugins/php-custom-rules/src/main/java/org/sonar/samples/php/ForbiddenFunctionUseCheck.java#L54
  
• https://github.com/SonarSource/sonar-examples/blob/master/plugins/php-custom-rules/src/main/java/org/sonar/samples/php/OtherForbiddenFunctionUseCheck.java#L51
  
• https://github.com/SonarSource/sonar-examples/blob/master/plugins/php-custom-rules/src/main/java/org/sonar/samples/php/ForbiddenFunctionUseCheck.java#L31
  

[Alexandre Gigleux]

Hello,

Thanks for the feedback. Fixed.

Alex