Add some javadocs on ProfilesWS

SonarSource · May 6, 2014 · 8a35689 · 8a35689
1 parent e6de029
commit 8a35689
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/sonar-server/src/main/java/org/sonar/server/platform/ServerComponents.java b/sonar-server/src/main/java/org/sonar/server/platform/ServerComponents.java
@@ -113,9 +113,10 @@
 import org.sonar.server.qualitygate.RegisterQualityGates;
 import org.sonar.server.qualitygate.ws.*;
 import org.sonar.server.qualityprofile.*;
+import org.sonar.server.qualityprofile.ws.ActivateRuleAction;
 import org.sonar.server.qualityprofile.ws.ProfilesWs;
 import org.sonar.server.qualityprofile.ws.QProfileRestoreDefaultAction;
-import org.sonar.server.qualityprofile.ws.QualityProfilesWs;
+import org.sonar.server.qualityprofile.ws.QProfilesWs;
 import org.sonar.server.rule.*;
 import org.sonar.server.rule.ws.*;
 import org.sonar.server.rule2.RuleService;
@@ -284,10 +285,10 @@ void startLevel4Components(ComponentContainer pico) {
     pico.addSingleton(DefaultProfilesCache.class);
     pico.addSingleton(ESActiveRule.class);
     pico.addSingleton(QProfileRestoreDefaultAction.class);
+    pico.addSingleton(QProfilesWs.class);
     pico.addSingleton(ProfilesWs.class);
     pico.addSingleton(ActivateRuleAction.class);
     pico.addSingleton(RuleActivationService.class);
-    pico.addSingleton(QualityProfilesWs.class);
 
     // rule
     pico.addSingleton(AnnotationRuleParser.class);

diff --git a/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java b/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/ProfilesWs.java
@@ -23,12 +23,16 @@
 import org.sonar.api.server.ws.RailsHandler;
 import org.sonar.api.server.ws.WebService;
 
+/**
+ * List of quality profiles WS implemented in Rails.
+ * New WS on quality profiles MUST be declared in {@link org.sonar.server.qualityprofile.ws.QProfilesWs}
+ */
 public class ProfilesWs implements WebService {
 
   @Override
   public void define(Context context) {
     NewController controller = context.createController("api/profiles")
-      .setDescription("Quality profiles management");
+      .setDescription("Quality profiles management (implemented in Rails)");
 
     defineListAction(controller);
     defineBackupAction(controller);